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

General client update #1

Merged
merged 9 commits into from
Apr 14, 2024
Merged

General client update #1

merged 9 commits into from
Apr 14, 2024

Conversation

i-am-david-fernandez
Copy link
Contributor

@i-am-david-fernandez i-am-david-fernandez commented Jan 24, 2024

Overview

This changeset has three key areas of change:

Update generator to use Docker

The previous/existing generator script directly used the Java-based OpenAPI generator tool. To ease use, this change moves to a docker-based approach, using official docker images for the tool. This is intended to allow easy upgrade/change of tool version as required.

Update API spec

The API spec has been updated/tweaked as a result of further/deeper use, and to reflect changes in the API itself (e.g., field type changes).

Regenerate client

The client code/tests/documentation has been regenerated from the above spec via the above tooling.

Summary of changes

Note: I have flagged the key files that have been manually changed (as opposed to the very many files that have changed as a result of regeneration).

  • Modified generation to use docker.
  • Schema tweaks.
  • Schema tweaks and extensions.
  • Renamed "Class" to "SchoolClass" to avoid keyword collision.
  • Renamed script.
  • DOB field tweak.
  • Added vscode stuff to gitignore.
  • Regenerated from updated spec.

@@ -78,6 +78,8 @@ paths:
- $ref: '#/components/parameters/UpdatedAfter'
- $ref: '#/components/parameters/UpdatedBefore'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/PageOffset'
- $ref: '#/components/parameters/PageCursor'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These allow for pagination of results.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This has been updated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This has been updated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This has been updated.

Copy link
Member

@MattFisher MattFisher left a comment

Choose a reason for hiding this comment

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

Nice updates!
Docker is much cleaner.
Good call on Class => SchoolClass.

@i-am-david-fernandez i-am-david-fernandez merged commit 9613be0 into main Apr 14, 2024
10 checks passed
@i-am-david-fernandez i-am-david-fernandez deleted the david/update branch April 14, 2024 21:24
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