From 709905f504427b08d30d64dfbe72848dad36fc29 Mon Sep 17 00:00:00 2001 From: Hasini Samarathunga Date: Wed, 26 Mar 2025 13:22:39 +0530 Subject: [PATCH] Remove structural type from Organization POST request documentation --- .../restapis/org-management.yaml | 29 ++++++++++++++++++- .../docs/apis/restapis/org-management.yaml | 29 ++++++++++++++++++- .../restapis/organization-management.yaml | 29 ++++++++++++++++++- .../restapis/organization-management.yaml | 29 ++++++++++++++++++- .../restapis/organization-management.yaml | 29 ++++++++++++++++++- .../restapis/organization-management.yaml | 29 ++++++++++++++++++- .../restapis/organization-management.yaml | 29 ++++++++++++++++++- .../restapis/organization-management.yaml | 29 ++++++++++++++++++- 8 files changed, 224 insertions(+), 8 deletions(-) diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/org-management.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/org-management.yaml index b1baa0d403..ee9f9f1cd4 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/org-management.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/org-management.yaml @@ -34,7 +34,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OrganizationPOSTRequest' + type: object + required: + - name + properties: + name: + type: string + example: "ABC Builders" + description: + type: string + example: "Building constructions" + parentId: + type: string + description: "The parent organization id should be the organization where the request is invoked. If a value is not specified it will be resolved internally." + attributes: + type: array + items: + $ref: '#/components/schemas/Attribute' + example: + { + "name": "ABC Builders", + "description": "Building constructions", + "attributes": [ + { + "key": "Country", + "value": "USA" + } + ] + } description: This represents the organization to be added. required: true responses: diff --git a/en/asgardeo/docs/apis/restapis/org-management.yaml b/en/asgardeo/docs/apis/restapis/org-management.yaml index 4e1fc329ff..a0eff51388 100644 --- a/en/asgardeo/docs/apis/restapis/org-management.yaml +++ b/en/asgardeo/docs/apis/restapis/org-management.yaml @@ -33,7 +33,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OrganizationPOSTRequest' + type: object + required: + - name + properties: + name: + type: string + example: "ABC Builders" + description: + type: string + example: "Building constructions" + parentId: + type: string + description: "The parent organization id should be the organization where the request is invoked. If a value is not specified it will be resolved internally." + attributes: + type: array + items: + $ref: '#/components/schemas/Attribute' + example: + { + "name": "ABC Builders", + "description": "Building constructions", + "attributes": [ + { + "key": "Country", + "value": "USA" + } + ] + } description: This represents the organization to be added. required: true responses: diff --git a/en/identity-server/7.0.0/docs/apis/organization-apis/restapis/organization-management.yaml b/en/identity-server/7.0.0/docs/apis/organization-apis/restapis/organization-management.yaml index 83ba4a0bf0..f67eaef646 100644 --- a/en/identity-server/7.0.0/docs/apis/organization-apis/restapis/organization-management.yaml +++ b/en/identity-server/7.0.0/docs/apis/organization-apis/restapis/organization-management.yaml @@ -29,7 +29,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OrganizationPOSTRequest' + type: object + required: + - name + properties: + name: + type: string + example: "ABC Builders" + description: + type: string + example: "Building constructions" + parentId: + type: string + description: "The parent organization id should be the organization where the request is invoked. If a value is not specified it will be resolved internally." + attributes: + type: array + items: + $ref: '#/components/schemas/Attribute' + example: + { + "name": "ABC Builders", + "description": "Building constructions", + "attributes": [ + { + "key": "Country", + "value": "USA" + } + ] + } description: This represents the organization to be added. required: true responses: diff --git a/en/identity-server/7.0.0/docs/apis/restapis/organization-management.yaml b/en/identity-server/7.0.0/docs/apis/restapis/organization-management.yaml index ce5a3752a1..e7bfbaa2f0 100644 --- a/en/identity-server/7.0.0/docs/apis/restapis/organization-management.yaml +++ b/en/identity-server/7.0.0/docs/apis/restapis/organization-management.yaml @@ -33,7 +33,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OrganizationPOSTRequest' + type: object + required: + - name + properties: + name: + type: string + example: "ABC Builders" + description: + type: string + example: "Building constructions" + parentId: + type: string + description: "The parent organization id should be the organization where the request is invoked. If a value is not specified it will be resolved internally." + attributes: + type: array + items: + $ref: '#/components/schemas/Attribute' + example: + { + "name": "ABC Builders", + "description": "Building constructions", + "attributes": [ + { + "key": "Country", + "value": "USA" + } + ] + } description: This represents the organization to be added. required: true responses: diff --git a/en/identity-server/7.1.0/docs/apis/organization-apis/restapis/organization-management.yaml b/en/identity-server/7.1.0/docs/apis/organization-apis/restapis/organization-management.yaml index 64c95d875f..7699a45c8f 100644 --- a/en/identity-server/7.1.0/docs/apis/organization-apis/restapis/organization-management.yaml +++ b/en/identity-server/7.1.0/docs/apis/organization-apis/restapis/organization-management.yaml @@ -29,7 +29,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OrganizationPOSTRequest' + type: object + required: + - name + properties: + name: + type: string + example: "ABC Builders" + description: + type: string + example: "Building constructions" + parentId: + type: string + description: "The parent organization id should be the organization where the request is invoked. If a value is not specified it will be resolved internally." + attributes: + type: array + items: + $ref: '#/components/schemas/Attribute' + example: + { + "name": "ABC Builders", + "description": "Building constructions", + "attributes": [ + { + "key": "Country", + "value": "USA" + } + ] + } description: This represents the organization to be added. required: true responses: diff --git a/en/identity-server/7.1.0/docs/apis/restapis/organization-management.yaml b/en/identity-server/7.1.0/docs/apis/restapis/organization-management.yaml index 36f8406037..b411e3ce06 100644 --- a/en/identity-server/7.1.0/docs/apis/restapis/organization-management.yaml +++ b/en/identity-server/7.1.0/docs/apis/restapis/organization-management.yaml @@ -33,7 +33,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OrganizationPOSTRequest' + type: object + required: + - name + properties: + name: + type: string + example: "ABC Builders" + description: + type: string + example: "Building constructions" + parentId: + type: string + description: "The parent organization id should be the organization where the request is invoked. If a value is not specified it will be resolved internally." + attributes: + type: array + items: + $ref: '#/components/schemas/Attribute' + example: + { + "name": "ABC Builders", + "description": "Building constructions", + "attributes": [ + { + "key": "Country", + "value": "USA" + } + ] + } description: This represents the organization to be added. required: true responses: diff --git a/en/identity-server/next/docs/apis/organization-apis/restapis/organization-management.yaml b/en/identity-server/next/docs/apis/organization-apis/restapis/organization-management.yaml index 64c95d875f..7699a45c8f 100644 --- a/en/identity-server/next/docs/apis/organization-apis/restapis/organization-management.yaml +++ b/en/identity-server/next/docs/apis/organization-apis/restapis/organization-management.yaml @@ -29,7 +29,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OrganizationPOSTRequest' + type: object + required: + - name + properties: + name: + type: string + example: "ABC Builders" + description: + type: string + example: "Building constructions" + parentId: + type: string + description: "The parent organization id should be the organization where the request is invoked. If a value is not specified it will be resolved internally." + attributes: + type: array + items: + $ref: '#/components/schemas/Attribute' + example: + { + "name": "ABC Builders", + "description": "Building constructions", + "attributes": [ + { + "key": "Country", + "value": "USA" + } + ] + } description: This represents the organization to be added. required: true responses: diff --git a/en/identity-server/next/docs/apis/restapis/organization-management.yaml b/en/identity-server/next/docs/apis/restapis/organization-management.yaml index 36f8406037..b411e3ce06 100644 --- a/en/identity-server/next/docs/apis/restapis/organization-management.yaml +++ b/en/identity-server/next/docs/apis/restapis/organization-management.yaml @@ -33,7 +33,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OrganizationPOSTRequest' + type: object + required: + - name + properties: + name: + type: string + example: "ABC Builders" + description: + type: string + example: "Building constructions" + parentId: + type: string + description: "The parent organization id should be the organization where the request is invoked. If a value is not specified it will be resolved internally." + attributes: + type: array + items: + $ref: '#/components/schemas/Attribute' + example: + { + "name": "ABC Builders", + "description": "Building constructions", + "attributes": [ + { + "key": "Country", + "value": "USA" + } + ] + } description: This represents the organization to be added. required: true responses: