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

DOP-3503: Add OpenAPI Versioning support to parser #449

Merged
merged 10 commits into from
Feb 16, 2023
Merged

Conversation

mmeigs
Copy link
Collaborator

@mmeigs mmeigs commented Feb 14, 2023

Ticket

DOP-3503

Notes

Adds support for OpenAPI versions. Version data should be validated and passed as build metadata.

New openapi directive options called versions and api-version are implemented to allow the parser to source version data from APIx endpoints.

In-depth information on these changes and parameters here.

Three thoughts and questions are provided below!

@mmeigs mmeigs marked this pull request as ready for review February 14, 2023 20:02
snooty/parser.py Outdated Show resolved Hide resolved
snooty/postprocess.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@rayangler rayangler left a comment

Choose a reason for hiding this comment

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

The metadata looks good! Just a few comments for now

snooty/parser.py Outdated Show resolved Hide resolved
snooty/postprocess.py Outdated Show resolved Hide resolved
snooty/postprocess.py Outdated Show resolved Hide resolved
snooty/rstspec.toml Outdated Show resolved Hide resolved
Copy link
Collaborator

@rayangler rayangler left a comment

Choose a reason for hiding this comment

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

LGTM!

snooty/diagnostics.py Outdated Show resolved Hide resolved
snooty/postprocess.py Outdated Show resolved Hide resolved
@mmeigs mmeigs requested a review from i80and February 16, 2023 14:50
@mmeigs mmeigs merged commit 122e206 into master Feb 16, 2023
@mmeigs mmeigs deleted the DOP-3503-versioning branch February 16, 2023 15:33
mmeigs added a commit that referenced this pull request Mar 27, 2023
* accessed version data, fetch apix data, added complete data to openapi_pages

* created diagnostic InvalidVersion, implemented in postprocess

* added two tests for openapi versioning

* remove hardcoded test data

* reorganized openapi postprocess, added InvalidOpenApiResponse diagnostic error

* clean

* PR feedback

* Further PR feedback

* PR feedback: flutter type check, deletion of other checks

* fixed Sequence error, added todo

Add openapi option api-version to rstspec.toml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants