Skip to content

Remove structural type from Organization POST request documentation #5208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Remove structural type from Organization POST request documentation #5208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion en/asgardeo/docs/apis/organization-apis/restapis/org-management.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
29 changes: 28 additions & 1 deletion en/asgardeo/docs/apis/restapis/org-management.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
29 changes: 28 additions & 1 deletion en/identity-server/7.0.0/docs/apis/organization-apis/restapis/organization-management.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
29 changes: 28 additions & 1 deletion en/identity-server/7.0.0/docs/apis/restapis/organization-management.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
29 changes: 28 additions & 1 deletion en/identity-server/7.1.0/docs/apis/organization-apis/restapis/organization-management.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,34 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationPOSTRequest'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any particular reason not to update the existing schema and duplicating the schema content here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the schema is specified in the API server we don't change it, it's recommended to change it this way.

Please refer: #5093 (comment)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#5093 (comment) comment is about simplifying the example.

In the current PR's case, we are changing the schema fully. Therefore let's edit the schema

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:
Expand Down
29 changes: 28 additions & 1 deletion en/identity-server/7.1.0/docs/apis/restapis/organization-management.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
29 changes: 28 additions & 1 deletion en/identity-server/next/docs/apis/organization-apis/restapis/organization-management.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
29 changes: 28 additions & 1 deletion en/identity-server/next/docs/apis/restapis/organization-management.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down