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

[2201.11.0] Update OpenAPI changes for U11 #9622

Open
wants to merge 1 commit into
base: release-2201.11.0
Choose a base branch
from

Conversation

lnash94
Copy link
Member

@lnash94 lnash94 commented Nov 28, 2024

Purpose

Subject

Fixes # partial ballerina-platform/ballerina-library#7420

Checklist

  • Page addition

    • Add permalink to pages.
  • Page removal

    • Remove entry from corresponding left nav YAML file.
    • Add redirect_from on the alternative page.
    • If no alternative page, add redirection on the redirections.js file.
  • Page rename

    • Add front-matter redirect_from.
    • Add front-matter redirect_to: (if applicable).
  • Page restrcuture

    • Add permalink to pages.
    • Add front-matter redirect_from.
    • Add front-matter redirect_to: (if applicable).

Comment on lines +72 to +74
- Introduced the `sanitize` sub-command, which sanitizes the OpenAPI contract file according to Ballerina's best
naming practices. The Ballerina name extensions are added to the schemas which can not be modified directly.
The output is a modified OpenAPI contract.
Copy link
Member

@daneshk daneshk Nov 28, 2024

Choose a reason for hiding this comment

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

Suggested change
- Introduced the `sanitize` sub-command, which sanitizes the OpenAPI contract file according to Ballerina's best
naming practices. The Ballerina name extensions are added to the schemas which can not be modified directly.
The output is a modified OpenAPI contract.
- Introduced the `sanitize` sub-command, which sanitizes the OpenAPI contract file according to Ballerina's best naming practices. The Ballerina name extensions are added to the schemas, which can not be modified directly.
The output is a modified OpenAPI contract.

Comment on lines +79 to +80
- Add code generation support with the new Ballerina name extensions. These extensions are mapped as relevant
annotations in the generated types, parameters and record fields.
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
- Add code generation support with the new Ballerina name extensions. These extensions are mapped as relevant
annotations in the generated types, parameters and record fields.
- Added code generation support with the new Ballerina name extensions. These extensions are mapped as relevant annotations in the generated types, parameters, and record fields.

Comment on lines +118 to +119
- Added support for relaxed data binding on the client side payload. This enables, `nil` values are treated as optional,
and absent fields are handled as `nilable` types.
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
- Added support for relaxed data binding on the client side payload. This enables, `nil` values are treated as optional,
and absent fields are handled as `nilable` types.
- Added support for relaxed data binding on the client-side payload. This enables `nil` values to be treated as optional, and absent fields are handled as `nilable` types.

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