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

feat: add /schema/openapi.yml to the available schema paths #2411

Merged
merged 4 commits into from
Oct 7, 2023

Conversation

JacobCoffee
Copy link
Member

Pull Request Checklist

  • New code has 100% test coverage
  • (If applicable) The prose documentation has been updated to reflect the changes introduced by this PR
  • (If applicable) The reference documentation has been updated to reflect the changes introduced by this PR
  • Pre-Commit Checks were ran and passed
  • Tests were ran and passed

Description

  • Updates all CI files to standardize on .yml (we had a mix before)
  • Adds a .yml available path for generate_openapi_schema, its respective routes in litestar.openapi.controller.OpenAPIController.retrieve_schema_yaml, and accompanying tests.

Close Issue(s)

@JacobCoffee JacobCoffee marked this pull request as ready for review October 7, 2023 02:03
@JacobCoffee JacobCoffee requested review from provinzkraut and a team as code owners October 7, 2023 02:03
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

Copy link
Member

@cofin cofin left a comment

Choose a reason for hiding this comment

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

LGTM and no issue with having them both there.

@JacobCoffee JacobCoffee force-pushed the standardize-on-something-for-yml branch from 8b1ca94 to fcc53fa Compare October 7, 2023 02:21
@JacobCoffee JacobCoffee force-pushed the standardize-on-something-for-yml branch from fcc53fa to 900d569 Compare October 7, 2023 05:51
@JacobCoffee JacobCoffee enabled auto-merge (squash) October 7, 2023 05:54
@JacobCoffee JacobCoffee merged commit 6f084ef into main Oct 7, 2023
@JacobCoffee JacobCoffee deleted the standardize-on-something-for-yml branch October 7, 2023 06:25
@sonarqubecloud
Copy link

sonarqubecloud bot commented Oct 7, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

100.0% 100.0% Coverage
0.0% 0.0% Duplication

@github-actions
Copy link

github-actions bot commented Oct 7, 2023

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/2411

Copy link
Member

Choose a reason for hiding this comment

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

Just fyi: This rename breaks our PyPI pipeline. It needs the workflow filename hardcoded, so if you're changing this, you'll also need to change it there.

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