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

[BUG]: fix bad OpenAPI generation #3445

Merged
merged 1 commit into from
Jan 9, 2025
Merged

[BUG]: fix bad OpenAPI generation #3445

merged 1 commit into from
Jan 9, 2025

Conversation

codetheweb
Copy link
Contributor

@codetheweb codetheweb commented Jan 8, 2025

Description of changes

PR #3310 broke the OpenAPI spec by generating a snippet for a request body that included:

"include": {
  "default": [
    "metadatas",
    "documents",
    "distances"
  ],
  "items": {
    "$ref": "#/$defs/IncludeEnum"
  },
  "title": "Include",
  "type": "array"
}

This $ref is invalid because the corresponding $def was placed as a sibling to this fragment, rather than at the top level of the document ($refs are always absolute). A thread where others ran into the same issue: https://community.sanicframework.org/t/problem-with-generated-openapi-schema-via-pydantic/1223

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

The genapi JS script now runs successfully.

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

n/a

Copy link

github-actions bot commented Jan 8, 2025

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@codetheweb codetheweb marked this pull request as ready for review January 8, 2025 22:58
@codetheweb codetheweb requested a review from drewkim January 8, 2025 22:58
@codetheweb codetheweb merged commit d50a942 into main Jan 9, 2025
78 checks passed
@codetheweb codetheweb deleted the bug-openapi-ref branch January 9, 2025 00:02
@tazarov tazarov mentioned this pull request Jan 16, 2025
1 task
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