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.

Sign up for GitHub

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

Jump to bottom

feat(deps): include pyramid_openapi3 #15553

Merged
merged 10 commits into from Mar 22, 2024
Merged

feat(deps): include pyramid_openapi3 #15553

merged 10 commits into from Mar 22, 2024

Conversation

miketheman
Copy link
Member

@miketheman miketheman commented Mar 12, 2024 •
edited

Introduce pyramid_openapi3 as a way to:

  • create API-specific definitions (openapi.yaml) that performs request and response validation, reducing the need to handle validations in-view
  • provide an API documentation and try-out site (aka explorer)
  • lay the foundation for more API endpoint development

miketheman
miketheman commented Mar 12, 2024
View reviewed changes
docker-compose.yml Show resolved Hide resolved
warehouse/api/echo.py Show resolved Hide resolved
miketheman
miketheman commented Mar 12, 2024
View reviewed changes
Copy link
Member Author

@miketheman miketheman left a comment

Choose a reason for hiding this comment

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

Try it out by checking out the code, running it, and visiting http://localhost/api/explorer

warehouse/api/openapi.yaml Show resolved Hide resolved
warehouse/api/openapi.yaml Outdated Show resolved Hide resolved
@miketheman miketheman force-pushed the miketheman/openapi branch 4 times, most recently from 5acb2e2 to f9cd692 Compare March 15, 2024 13:57
@miketheman miketheman marked this pull request as ready for review March 15, 2024 13:58
@miketheman miketheman requested a review from a team as a code owner March 15, 2024 13:58
@miketheman miketheman force-pushed the miketheman/openapi branch 4 times, most recently from c67421d to 98f9615 Compare March 20, 2024 14:27
@miketheman
feat(deps): include pyramid_openapi3
67b436e 
Signed-off-by: Mike Fiedler <miketheman@gmail.com>
@miketheman
wip working version with custom header
590df2f 
Signed-off-by: Mike Fiedler <miketheman@gmail.com>
@miketheman
convert to using accept and add more pieces
4e8e742 
Signed-off-by: Mike Fiedler <miketheman@gmail.com>
@miketheman
feat: add submission
125b570 
Signed-off-by: Mike Fiedler <miketheman@gmail.com>
@miketheman
tests
bf52d7f 
Signed-off-by: Mike Fiedler <miketheman@gmail.com>
@miketheman
chore: remove servers key to auto-detect the correct url
4cc1540 
Signed-off-by: Mike Fiedler <miketheman@gmail.com>
@miketheman
tests: don't depend on code location
655c36f 
Signed-off-by: Mike Fiedler <miketheman@gmail.com>
@miketheman miketheman requested review from di and ewdurbin March 22, 2024 13:50
@miketheman miketheman merged commit 8f79d90 into pypi:main Mar 22, 2024
17 checks passed
@miketheman miketheman deleted the miketheman/openapi branch March 22, 2024 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@di di di approved these changes

@ewdurbin ewdurbin Awaiting requested review from ewdurbin

Assignees
No one assigned
Labels
APIs/feeds
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@miketheman @di @ewdurbin