Skip to content
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

Improve the readability of Rest API Document #8790

Open
wants to merge 3 commits into
base: 4.1.0
Choose a base branch
from

Conversation

shilmyhasan
Copy link
Contributor

Purpose

Improve the readability of the rest api document to provide more understanding to the end user.

example: PUBLIC
enum:
- PUBLIC
- SINGLE
audiences:
type: array
description: The allowed audiences for the API for jwt validation. Accepted values are any String values
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
description: The allowed audiences for the API for jwt validation. Accepted values are any String values
description: The allowed audiences for the API for jwt validation. Any string value is accepted.

example: PUBLIC
enum:
- PUBLIC
- SINGLE
audiences:
type: array
description: The allowed audiences for the API for jwt validation. Accepted values are any String values
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
description: The allowed audiences for the API for jwt validation. Accepted values are any String values
description: The allowed audiences for the API for jwt validation. Any string value is accepted.

@@ -9041,6 +9105,12 @@ components:
gatewayVendor:
type: string
example: wso2
audiences:
type: array
description: The audiences of the API product for jwt validation. Accepted values are any String values
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
description: The audiences of the API product for jwt validation. Accepted values are any String values
description: The audiences of the API product for jwt validation. Any string value is accepted.

@@ -9289,6 +9365,12 @@ components:
workflowStatus:
type: string
example: APPROVED
audiences:
type: array
description: The audiences of the API for jwt validation. Accepted values are any String values
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
description: The audiences of the API for jwt validation. Accepted values are any String values
description: The audiences of the API for jwt validation. Any string value is accepted.

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.

2 participants