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

Openapi examples check #2240

Merged
merged 3 commits into from
Jan 23, 2025
Merged

Openapi examples check #2240

merged 3 commits into from
Jan 23, 2025

Conversation

sfauvel
Copy link
Collaborator

@sfauvel sfauvel commented Jan 22, 2025

Content

To be conform to the OpenAPI specification 3.1, in a previous commit we have changed example property to examples.
Doing that, we have created 2 issues:

  • Examples are no longer verified because we only looking for example property
  • Examples are not correctly displayed because the examples property must contain an array of examples.

This PR fix this two issues and adjust the relative path to openapi.yamlto generate locally aggregator-api with docusaurus.
ApiSpec tests are modified to take into account examples property.

Pre-submit checklist

  • Branch
    • Tests are provided (if possible)
    • Crates versions are updated (if relevant)
    • CHANGELOG file is updated (if relevant)
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • No clippy warnings in the CI
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested
  • Documentation
    • Update README file (if relevant)
    • Update documentation website (if relevant)
    • Add dev blog post (if relevant)

Issue(s)

Closes #2235

Copy link

github-actions bot commented Jan 22, 2025

Test Results

    4 files  ±0     52 suites  ±0   10m 30s ⏱️ -2s
1 543 tests +4  1 543 ✅ +4  0 💤 ±0  0 ❌ ±0 
1 799 runs  +4  1 799 ✅ +4  0 💤 ±0  0 ❌ ±0 

Results for commit 829e4e4. ± Comparison against base commit e1de875.

♻️ This comment has been updated with latest results.

@sfauvel sfauvel force-pushed the sfa/2235/openapi_examples_check branch 2 times, most recently from 848dfb1 to a02e24c Compare January 22, 2025 15:05
@sfauvel sfauvel marked this pull request as ready for review January 22, 2025 15:12
Copy link
Collaborator

@Alenar Alenar left a comment

Choose a reason for hiding this comment

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

LGTM 🔥

Copy link
Member

@jpraynaud jpraynaud left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@sfauvel sfauvel force-pushed the sfa/2235/openapi_examples_check branch 2 times, most recently from 5a391dd to c9ec212 Compare January 23, 2025 09:22
@sfauvel sfauvel temporarily deployed to testing-preview January 23, 2025 09:31 — with GitHub Actions Inactive
@sfauvel sfauvel temporarily deployed to testing-sanchonet January 23, 2025 09:31 — with GitHub Actions Inactive
@sfauvel sfauvel force-pushed the sfa/2235/openapi_examples_check branch from c9ec212 to 829e4e4 Compare January 23, 2025 09:51
@sfauvel sfauvel temporarily deployed to testing-preview January 23, 2025 10:00 — with GitHub Actions Inactive
@sfauvel sfauvel temporarily deployed to testing-sanchonet January 23, 2025 10:00 — with GitHub Actions Inactive
@sfauvel sfauvel merged commit d1dc173 into main Jan 23, 2025
43 checks passed
@sfauvel sfauvel deleted the sfa/2235/openapi_examples_check branch January 23, 2025 10:06
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.

OpenAPI examples check is not working
4 participants