Fix create external id: Use externalid accept header value instead …

…of application/json (#230) * dev: add missing api spec option * fix(c8y identity create): add specific accept header to avoid 406 errors
reubenmiller · Mar 5, 2023 · 574e828 · 574e828
1 parent 79d551f
commit 574e828
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 9 deletions.
diff --git a/api/spec/json/identity.json b/api/spec/json/identity.json
@@ -13,7 +13,7 @@
       "descriptionLong": "Get a collection of external ids related to an existing managed object",
       "path": "identity/globalIds/{device}/externalIds",
       "accept": "application/vnd.com.nsn.cumulocity.externalIdCollection+json",
-      "collectionType": "application/vnd.com.nsn.cumulocity.externalId+json",
+      "collectionType": "application/vnd.com.nsn.cumulocity.externalid+json",
       "collectionProperty": "externalIds",
       "alias": {
         "go": "list",
@@ -71,7 +71,7 @@
       "descriptionLong": "Get an external identity object. An external identify will include the reference to a single device managed object\n",
       "method": "GET",
       "path": "/identity/externalIds/{type}/{name}",
-      "accept": "application/vnd.com.nsn.cumulocity.externalId+json",
+      "accept": "application/vnd.com.nsn.cumulocity.externalid+json",
       "alias": {
         "go": "get",
         "powershell": "Get-ExternalId"
@@ -187,7 +187,8 @@
       "name": "newExternalID",
       "method": "POST",
       "path": "identity/globalIds/{device}/externalIds",
-      "accept": "application/vnd.com.nsn.cumulocity.externalId+json",
+      "addAccept": true,
+      "accept": "application/vnd.com.nsn.cumulocity.externalid+json",
       "description": "Create external identity",
       "descriptionLong": "Create a new external id for an existing managed object",
       "alias": {

diff --git a/api/spec/schema.json b/api/spec/schema.json
@@ -334,6 +334,10 @@
             "type": "string",
             "title": "Partial url i.e. /alarm/alarms"
           },
+          "addAccept": {
+            "type": "boolean",
+            "description": "Add an explicit Accept header value if set"
+          },
           "accept": {
             "type": "string",
             "description": "Accept header value. Data to be returned from the platform. The accept header will also control how the data will be displayed within the PowerShell module"

diff --git a/api/spec/yaml/identity.yaml b/api/spec/yaml/identity.yaml
@@ -13,7 +13,7 @@ endpoints:
     descriptionLong: Get a collection of external ids related to an existing managed object
     path: identity/globalIds/{device}/externalIds
     accept: application/vnd.com.nsn.cumulocity.externalIdCollection+json
-    collectionType: application/vnd.com.nsn.cumulocity.externalId+json
+    collectionType: application/vnd.com.nsn.cumulocity.externalid+json
     collectionProperty: externalIds
     alias:
         go: list
@@ -58,7 +58,7 @@ endpoints:
       Get an external identity object. An external identify will include the reference to a single device managed object
     method: GET
     path: /identity/externalIds/{type}/{name}
-    accept: application/vnd.com.nsn.cumulocity.externalId+json
+    accept: application/vnd.com.nsn.cumulocity.externalid+json
     alias:
         go: get
         powershell: Get-ExternalId
@@ -143,7 +143,8 @@ endpoints:
   - name: newExternalID
     method: POST
     path: identity/globalIds/{device}/externalIds
-    accept: application/vnd.com.nsn.cumulocity.externalId+json
+    addAccept: true
+    accept: application/vnd.com.nsn.cumulocity.externalid+json
     description: Create external identity
     descriptionLong: Create a new external id for an existing managed object
     alias:

diff --git a/pkg/cmd/identity/create/create.auto.go b/pkg/cmd/identity/create/create.auto.go
diff --git a/tools/PSc8y/Public/Get-ExternalId.ps1 b/tools/PSc8y/Public/Get-ExternalId.ps1
@@ -49,7 +49,7 @@ Get external identity
         $c8yargs = New-ClientArgument -Parameters $PSBoundParameters -Command "identity get"
         $ClientOptions = Get-ClientOutputOption $PSBoundParameters
         $TypeOptions = @{
-            Type = "application/vnd.com.nsn.cumulocity.externalId+json"
+            Type = "application/vnd.com.nsn.cumulocity.externalid+json"
             ItemType = ""
             BoundParameters = $PSBoundParameters
         }

diff --git a/tools/PSc8y/Public/Get-ExternalIdCollection.ps1 b/tools/PSc8y/Public/Get-ExternalIdCollection.ps1
@@ -44,7 +44,7 @@ Get a list of external ids
         $ClientOptions = Get-ClientOutputOption $PSBoundParameters
         $TypeOptions = @{
             Type = "application/vnd.com.nsn.cumulocity.externalIdCollection+json"
-            ItemType = "application/vnd.com.nsn.cumulocity.externalId+json"
+            ItemType = "application/vnd.com.nsn.cumulocity.externalid+json"
             BoundParameters = $PSBoundParameters
         }
     }

diff --git a/tools/PSc8y/Public/New-ExternalId.ps1 b/tools/PSc8y/Public/New-ExternalId.ps1
@@ -58,7 +58,7 @@ Create external identity (using pipeline)
         $c8yargs = New-ClientArgument -Parameters $PSBoundParameters -Command "identity create"
         $ClientOptions = Get-ClientOutputOption $PSBoundParameters
         $TypeOptions = @{
-            Type = "application/vnd.com.nsn.cumulocity.externalId+json"
+            Type = "application/vnd.com.nsn.cumulocity.externalid+json"
             ItemType = ""
             BoundParameters = $PSBoundParameters
         }