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.

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

Conversation

HasiniSama
Copy link
Contributor

@HasiniSama HasiniSama commented Mar 26, 2025

Purpose

$subject

Fixes: wso2/product-is#23539

Goals

Since we are moving away from the "STRUCTURAL" type for organizations, it will be deprecated, hence this needs to be removed from the Docs.

Approach

Before
Screenshot 2025-03-26 at 13 25 26

After
Screenshot 2025-03-26 at 12 18 34

@HasiniSama
Copy link
Contributor Author

Note:

Please note the response will still contain this ,as removing it would be an inconsistency with the API.

Screenshot 2025-03-26 at 12 18 54

@@ -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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove STRUCTURAL type from Organization Management POST API
2 participants