fix(sdk): use proper annotation for genericError (#1611)

Closes #1609

.schema/openapi/patches/generic_error.yaml

@@ -0,0 +1,6 @@
+- op: add
+  path: /paths/~1sessions~1whoami/get/parameters/0/example
+  value: MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj
+- op: add
+  path: /paths/~1sessions~1whoami/get/parameters/1/example
+  value: ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==

.schema/openapi/patches/security.yaml

@@ -1,10 +1,3 @@
 - op: replace
-  path: /components/securitySchemes/oryAccessToken
-  value:
-    type: http
-    scheme: bearer
-    description: |
-      This security mechanism is only applicable when using the [Ory Platform](https://console.ory.sh) by
-      creating an [Ory Personal Access Token](https://www.ory.sh/docs/guides/create-personal-access-token).
-      If you are using the open source version, this security mechanism
-      will not work out of the box as you will need to add a security mechanism yourself.
+  path: /components/schemas/genericError/properties/details/additionalProperties
+  value: false

Makefile

@@ -90,6 +90,7 @@ sdk: .bin/swagger .bin/ory node_modules
 					-p file://.schema/openapi/patches/security.yaml \
 					-p file://.schema/openapi/patches/session.yaml \
 					-p file://.schema/openapi/patches/identity.yaml \
+					-p file://.schema/openapi/patches/generic_error.yaml \
 					spec/swagger.json spec/api.json
 
 		rm -rf internal/httpclient/models internal/httpclient/clients

internal/httpclient/README.md

@@ -216,14 +216,11 @@ Class | Method | HTTP request | Description
 
 ### oryAccessToken
 
-- **Type**: HTTP Bearer token authentication
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
 
-Example
-
-```golang
-auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING")
-r, err := client.Service.Operation(auth, args)
-```
+Note, each API key must be added to a map of `map[string]APIKey` where the key is: Authorization and passed in as the auth context for each request.
 
 
 ## Documentation for Utility Methods

internal/httpclient/api/openapi.yaml

@@ -2660,7 +2660,7 @@ components:
           example: SQL field "foo" is not a bool.
           type: string
         details:
-          additionalProperties: true
+          additionalProperties: false
           description: Further error details
           type: object
         message:
@@ -4595,12 +4595,8 @@ components:
       type: object
   securitySchemes:
     oryAccessToken:
-      description: |
-        This security mechanism is only applicable when using the [Ory Platform](https://console.ory.sh) by
-        creating an [Ory Personal Access Token](https://www.ory.sh/docs/guides/create-personal-access-token).
-        If you are using the open source version, this security mechanism
-        will not work out of the box as you will need to add a security mechanism yourself.
-      scheme: bearer
-      type: http
+      in: header
+      name: Authorization
+      type: apiKey
 x-forwarded-proto: string
 x-request-id: string

internal/httpclient/docs/GenericError.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Code** | Pointer to **int64** | The status code | [optional] 
 **Debug** | Pointer to **string** | Debug information  This field is often not exposed to protect against leaking sensitive information. | [optional] 
-**Details** | Pointer to **map[string]map[string]interface{}** | Further error details | [optional] 
+**Details** | Pointer to **map[string]interface{}** | Further error details | [optional] 
 **Message** | **string** | Error message  The error's message. | 
 **Reason** | Pointer to **string** | A human-readable reason for the error | [optional] 
 **Request** | Pointer to **string** | The request ID  The request ID is often exposed internally in order to trace errors across service architectures. This is often a UUID. | [optional] 
@@ -83,20 +83,20 @@ HasDebug returns a boolean if a field has been set.
 
 ### GetDetails
 
-`func (o *GenericError) GetDetails() map[string]map[string]interface{}`
+`func (o *GenericError) GetDetails() map[string]interface{}`
 
 GetDetails returns the Details field if non-nil, zero value otherwise.
 
 ### GetDetailsOk
 
-`func (o *GenericError) GetDetailsOk() (*map[string]map[string]interface{}, bool)`
+`func (o *GenericError) GetDetailsOk() (*map[string]interface{}, bool)`
 
 GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise
 and a boolean to check if the value has been set.
 
 ### SetDetails
 
-`func (o *GenericError) SetDetails(v map[string]map[string]interface{})`
+`func (o *GenericError) SetDetails(v map[string]interface{})`
 
 SetDetails sets Details field to given value.
 

spec/api.json

@@ -937,7 +937,7 @@
             "type": "string"
           },
           "details": {
-            "additionalProperties": true,
+            "additionalProperties": false,
             "description": "Further error details",
             "type": "object"
           },
@@ -2129,9 +2129,9 @@
     },
     "securitySchemes": {
       "oryAccessToken": {
-        "description": "This security mechanism is only applicable when using the [Ory Platform](https://console.ory.sh) by\ncreating an [Ory Personal Access Token](https://www.ory.sh/docs/guides/create-personal-access-token).\nIf you are using the open source version, this security mechanism\nwill not work out of the box as you will need to add a security mechanism yourself.\n",
-        "scheme": "bearer",
-        "type": "http"
+        "in": "header",
+        "name": "Authorization",
+        "type": "apiKey"
       }
     }
   },