refactor(sdk): rename getJsonSchema to getIdentitySchema (#2606)

BREAKING CHANGE: SDK Method `getJsonSchema` was renamed to `getIdentitySchema`.

Author: aeneasr

cmd/identities/validate.go

@@ -53,7 +53,7 @@ Identities can be supplied via STD_IN or JSON files containing a single or an ar
 
 			for src, i := range is {
 				err = ValidateIdentity(cmd, src, i, func(ctx context.Context, id string) (map[string]interface{}, *http.Response, error) {
-					return c.V0alpha2Api.GetJsonSchema(ctx, id).Execute()
+					return c.V0alpha2Api.GetIdentitySchema(ctx, id).Execute()
 				})
 				if err != nil {
 					return err

internal/httpclient/.openapi-generator/FILES

@@ -27,7 +27,7 @@ docs/IdentityCredentialsOidc.md
 docs/IdentityCredentialsOidcProvider.md
 docs/IdentityCredentialsPassword.md
 docs/IdentityCredentialsType.md
-docs/IdentitySchema.md
+docs/IdentitySchemaContainer.md
 docs/IdentityState.md
 docs/InlineResponse200.md
 docs/InlineResponse2001.md
@@ -119,7 +119,7 @@ model_identity_credentials_oidc.go
 model_identity_credentials_oidc_provider.go
 model_identity_credentials_password.go
 model_identity_credentials_type.go
-model_identity_schema.go
+model_identity_schema_container.go
 model_identity_state.go
 model_inline_response_200.go
 model_inline_response_200_1.go

internal/httpclient/README.md

@@ -97,7 +97,7 @@ Class | Method | HTTP request | Description
 *V0alpha2Api* | [**AdminPatchIdentity**](docs/V0alpha2Api.md#adminpatchidentity) | **Patch** /admin/identities/{id} | Partially updates an Identity's field using [JSON Patch](https://jsonpatch.com/)
 *V0alpha2Api* | [**AdminUpdateIdentity**](docs/V0alpha2Api.md#adminupdateidentity) | **Put** /admin/identities/{id} | Update an Identity
 *V0alpha2Api* | [**CreateSelfServiceLogoutFlowUrlForBrowsers**](docs/V0alpha2Api.md#createselfservicelogoutflowurlforbrowsers) | **Get** /self-service/logout/browser | Create a Logout URL for Browsers
-*V0alpha2Api* | [**GetJsonSchema**](docs/V0alpha2Api.md#getjsonschema) | **Get** /schemas/{id} | 
+*V0alpha2Api* | [**GetIdentitySchema**](docs/V0alpha2Api.md#getidentityschema) | **Get** /schemas/{id} | 
 *V0alpha2Api* | [**GetSelfServiceError**](docs/V0alpha2Api.md#getselfserviceerror) | **Get** /self-service/errors | Get Self-Service Errors
 *V0alpha2Api* | [**GetSelfServiceLoginFlow**](docs/V0alpha2Api.md#getselfserviceloginflow) | **Get** /self-service/login/flows | Get Login Flow
 *V0alpha2Api* | [**GetSelfServiceRecoveryFlow**](docs/V0alpha2Api.md#getselfservicerecoveryflow) | **Get** /self-service/recovery/flows | Get Recovery Flow
@@ -151,7 +151,7 @@ Class | Method | HTTP request | Description
  - [IdentityCredentialsOidcProvider](docs/IdentityCredentialsOidcProvider.md)
  - [IdentityCredentialsPassword](docs/IdentityCredentialsPassword.md)
  - [IdentityCredentialsType](docs/IdentityCredentialsType.md)
- - [IdentitySchema](docs/IdentitySchema.md)
+ - [IdentitySchemaContainer](docs/IdentitySchemaContainer.md)
  - [IdentityState](docs/IdentityState.md)
  - [InlineResponse200](docs/InlineResponse200.md)
  - [InlineResponse2001](docs/InlineResponse2001.md)

internal/httpclient/api/openapi.yaml

@@ -678,7 +678,7 @@ paths:
   /schemas/{id}:
     get:
       description: Get a JSON Schema
-      operationId: getJsonSchema
+      operationId: getIdentitySchema
       parameters:
       - description: ID must be set to the ID of schema you want to get
         explode: false
@@ -693,8 +693,8 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/jsonSchema'
-          description: jsonSchema
+                $ref: '#/components/schemas/identitySchema'
+          description: identitySchema
         "404":
           content:
             application/json:
@@ -3379,6 +3379,9 @@ components:
       title: A list of identities.
       type: array
     identitySchema:
+      description: Raw JSON Schema
+      type: object
+    identitySchemaContainer:
       example:
         schema: '{}'
         id: id
@@ -3387,13 +3390,13 @@ components:
           description: The ID of the Identity JSON Schema
           type: string
         schema:
-          description: The actual Identity JSON Schema
+          description: Raw JSON Schema
           type: object
       type: object
     identitySchemas:
       description: Raw identity Schema list
       items:
-        $ref: '#/components/schemas/identitySchema'
+        $ref: '#/components/schemas/identitySchemaContainer'
       type: array
     identityState:
       description: The state can either be `active` or `inactive`.
@@ -3461,9 +3464,6 @@ components:
       items:
         $ref: '#/components/schemas/jsonPatch'
       type: array
-    jsonSchema:
-      description: Raw JSON Schema
-      type: object
     needsPrivilegedSessionError:
       properties:
         code:

internal/httpclient/api_v0alpha2.go

@@ -1,78 +1,78 @@
-# IdentitySchema
+# IdentitySchemaContainer
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Id** | Pointer to **string** | The ID of the Identity JSON Schema | [optional] 
-**Schema** | Pointer to **map[string]interface{}** | The actual Identity JSON Schema | [optional] 
+**Schema** | Pointer to **map[string]interface{}** | Raw JSON Schema | [optional] 
 
 ## Methods
 
-### NewIdentitySchema
+### NewIdentitySchemaContainer
 
-`func NewIdentitySchema() *IdentitySchema`
+`func NewIdentitySchemaContainer() *IdentitySchemaContainer`
 
-NewIdentitySchema instantiates a new IdentitySchema object
+NewIdentitySchemaContainer instantiates a new IdentitySchemaContainer object
 This constructor will assign default values to properties that have it defined,
 and makes sure properties required by API are set, but the set of arguments
 will change when the set of required properties is changed
 
-### NewIdentitySchemaWithDefaults
+### NewIdentitySchemaContainerWithDefaults
 
-`func NewIdentitySchemaWithDefaults() *IdentitySchema`
+`func NewIdentitySchemaContainerWithDefaults() *IdentitySchemaContainer`
 
-NewIdentitySchemaWithDefaults instantiates a new IdentitySchema object
+NewIdentitySchemaContainerWithDefaults instantiates a new IdentitySchemaContainer object
 This constructor will only assign default values to properties that have it defined,
 but it doesn't guarantee that properties required by API are set
 
 ### GetId
 
-`func (o *IdentitySchema) GetId() string`
+`func (o *IdentitySchemaContainer) GetId() string`
 
 GetId returns the Id field if non-nil, zero value otherwise.
 
 ### GetIdOk
 
-`func (o *IdentitySchema) GetIdOk() (*string, bool)`
+`func (o *IdentitySchemaContainer) GetIdOk() (*string, bool)`
 
 GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise
 and a boolean to check if the value has been set.
 
 ### SetId
 
-`func (o *IdentitySchema) SetId(v string)`
+`func (o *IdentitySchemaContainer) SetId(v string)`
 
 SetId sets Id field to given value.
 
 ### HasId
 
-`func (o *IdentitySchema) HasId() bool`
+`func (o *IdentitySchemaContainer) HasId() bool`
 
 HasId returns a boolean if a field has been set.
 
 ### GetSchema
 
-`func (o *IdentitySchema) GetSchema() map[string]interface{}`
+`func (o *IdentitySchemaContainer) GetSchema() map[string]interface{}`
 
 GetSchema returns the Schema field if non-nil, zero value otherwise.
 
 ### GetSchemaOk
 
-`func (o *IdentitySchema) GetSchemaOk() (*map[string]interface{}, bool)`
+`func (o *IdentitySchemaContainer) GetSchemaOk() (*map[string]interface{}, bool)`
 
 GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise
 and a boolean to check if the value has been set.
 
 ### SetSchema
 
-`func (o *IdentitySchema) SetSchema(v map[string]interface{})`
+`func (o *IdentitySchemaContainer) SetSchema(v map[string]interface{})`
 
 SetSchema sets Schema field to given value.
 
 ### HasSchema
 
-`func (o *IdentitySchema) HasSchema() bool`
+`func (o *IdentitySchemaContainer) HasSchema() bool`
 
 HasSchema returns a boolean if a field has been set.
 

internal/httpclient/docs/IdentitySchema.md renamed to internal/httpclient/docs/IdentitySchemaContainer.md

@@ -15,7 +15,7 @@ Method | HTTP request | Description
 [**AdminPatchIdentity**](V0alpha2Api.md#AdminPatchIdentity) | **Patch** /admin/identities/{id} | Partially updates an Identity's field using [JSON Patch](https://jsonpatch.com/)
 [**AdminUpdateIdentity**](V0alpha2Api.md#AdminUpdateIdentity) | **Put** /admin/identities/{id} | Update an Identity
 [**CreateSelfServiceLogoutFlowUrlForBrowsers**](V0alpha2Api.md#CreateSelfServiceLogoutFlowUrlForBrowsers) | **Get** /self-service/logout/browser | Create a Logout URL for Browsers
-[**GetJsonSchema**](V0alpha2Api.md#GetJsonSchema) | **Get** /schemas/{id} | 
+[**GetIdentitySchema**](V0alpha2Api.md#GetIdentitySchema) | **Get** /schemas/{id} | 
 [**GetSelfServiceError**](V0alpha2Api.md#GetSelfServiceError) | **Get** /self-service/errors | Get Self-Service Errors
 [**GetSelfServiceLoginFlow**](V0alpha2Api.md#GetSelfServiceLoginFlow) | **Get** /self-service/login/flows | Get Login Flow
 [**GetSelfServiceRecoveryFlow**](V0alpha2Api.md#GetSelfServiceRecoveryFlow) | **Get** /self-service/recovery/flows | Get Recovery Flow
@@ -812,9 +812,9 @@ No authorization required
 [[Back to README]](../README.md)
 
 
-## GetJsonSchema
+## GetIdentitySchema
 
-> map[string]interface{} GetJsonSchema(ctx, id).Execute()
+> map[string]interface{} GetIdentitySchema(ctx, id).Execute()
 
 
 
@@ -837,13 +837,13 @@ func main() {
 
     configuration := openapiclient.NewConfiguration()
     apiClient := openapiclient.NewAPIClient(configuration)
-    resp, r, err := apiClient.V0alpha2Api.GetJsonSchema(context.Background(), id).Execute()
+    resp, r, err := apiClient.V0alpha2Api.GetIdentitySchema(context.Background(), id).Execute()
     if err != nil {
-        fmt.Fprintf(os.Stderr, "Error when calling `V0alpha2Api.GetJsonSchema``: %v\n", err)
+        fmt.Fprintf(os.Stderr, "Error when calling `V0alpha2Api.GetIdentitySchema``: %v\n", err)
         fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
     }
-    // response from `GetJsonSchema`: map[string]interface{}
-    fmt.Fprintf(os.Stdout, "Response from `V0alpha2Api.GetJsonSchema`: %v\n", resp)
+    // response from `GetIdentitySchema`: map[string]interface{}
+    fmt.Fprintf(os.Stdout, "Response from `V0alpha2Api.GetIdentitySchema`: %v\n", resp)
 }
 ```
 
@@ -857,7 +857,7 @@ Name | Type | Description  | Notes
 
 ### Other Parameters
 
-Other parameters are passed through a pointer to a apiGetJsonSchemaRequest struct via the builder pattern
+Other parameters are passed through a pointer to a apiGetIdentitySchemaRequest struct via the builder pattern
 
 
 Name | Type | Description  | Notes
@@ -2006,7 +2006,7 @@ No authorization required
 
 ## ListIdentitySchemas
 
-> []IdentitySchema ListIdentitySchemas(ctx).PerPage(perPage).Page(page).Execute()
+> []IdentitySchemaContainer ListIdentitySchemas(ctx).PerPage(perPage).Page(page).Execute()
 
 
 
@@ -2035,7 +2035,7 @@ func main() {
         fmt.Fprintf(os.Stderr, "Error when calling `V0alpha2Api.ListIdentitySchemas``: %v\n", err)
         fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
     }
-    // response from `ListIdentitySchemas`: []IdentitySchema
+    // response from `ListIdentitySchemas`: []IdentitySchemaContainer
     fmt.Fprintf(os.Stdout, "Response from `V0alpha2Api.ListIdentitySchemas`: %v\n", resp)
 }
 ```
@@ -2056,7 +2056,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**[]IdentitySchema**](IdentitySchema.md)
+[**[]IdentitySchemaContainer**](IdentitySchemaContainer.md)
 
 ### Authorization