Skip to content

Comments

Add generated client with necessary sanitizations#3

Merged
Nuvindu merged 13 commits intoballerina-platform:mainfrom
rtweera:main
Feb 18, 2025
Merged

Add generated client with necessary sanitizations#3
Nuvindu merged 13 commits intoballerina-platform:mainfrom
rtweera:main

Conversation

@rtweera
Copy link
Contributor

@rtweera rtweera commented Feb 14, 2025

Purpose

To generate ballerina client code from OpenAPI specifications with necessary sanitations

Examples

Checklist

  • Linked to an issue
  • Updated the changelog
  • Added tests
  • Updated the spec
  • Checked native-image compatibility

rtweera and others added 5 commits February 14, 2025 11:51
URL paths were duplicated and long. Add common path to server URL and
remove duplications. Makes the paths easier to read and maintain.

Add examples for parameters in the REST methods to show the correct
format of the parameter values. Helps to avoid validation errors.
@CLAassistant
Copy link

CLAassistant commented Feb 14, 2025

CLA assistant check
All committers have signed the CLA.

Co-authored-by: Nuvindu Nirmana <63797478+Nuvindu@users.noreply.github.com>
Created and Updated date format fix

Co-authored-by: Nuvindu Nirmana <63797478+Nuvindu@users.noreply.github.com>
Nuvindu
Nuvindu previously approved these changes Feb 17, 2025
rtweera and others added 4 commits February 17, 2025 17:21
Update docs/spec/openapi.json file to add nullable to the fields that
are optional in the API response. This ensures no json parsing errors
when the optional fields are not present in the response.

Update docs/spec/sanitations.md file to reflect the changes done on
docs/spec/openapi.json file.
Add descrition to the field hapikey in the openapi.json. This makes it
easier for the developers to understand the purpose of the field.

Add necessary changes in the sanitations.md to reflect the changes in
the openapi.json.
Generate client, types, and utils with updated sanitations to improve
documentation and better error handling.
@Nuvindu Nuvindu merged commit 2019bcc into ballerina-platform:main Feb 18, 2025
2 checks passed
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.

3 participants