Document schema resolver duplicate titles behaviour #656
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zorbash
commented
Mar 6, 2025
|
|
||
| new_schemas = | ||
| if Map.has_key?(schemas, title) do | ||
| schemas | ||
| else | ||
| {new_schema, schemas} = resolve_schema_modules_from_schema(schema.schema(), schemas) |
There was a problem hiding this comment.
We were calling schema/0 twice for no obvious reason.
zorbash
commented
Mar 6, 2025
Comment on lines
+74
to
+107
| "/api/users/{id}/friends" => %PathItem{ | ||
| get: %Operation{ | ||
| parameters: [ | ||
| %OpenApiSpex.Parameter{ | ||
| name: :id, | ||
| in: :path, | ||
| schema: %Schema{type: :integer} | ||
| } | ||
| ], | ||
| responses: %{ | ||
| 200 => %Response{ | ||
| description: "Success", | ||
| content: %{ | ||
| "application/json" => %MediaType{ | ||
| schema: %Schema{ | ||
| type: :array, | ||
| items: OpenApiSpexTest.Schemas.User | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/api/users/subscribe" => %PathItem{ | ||
| post: %Operation{ | ||
| description: "Subscribe to user updates", | ||
| operationId: "UserController.subscribe", | ||
| requestBody: %RequestBody{ | ||
| required: true, | ||
| content: %{ | ||
| "application/json" => %MediaType{ | ||
| schema: OpenApiSpexTest.Schemas.UserSubscribeRequest | ||
| }, | ||
| "/api/users/subscribe" => %PathItem{ | ||
| post: %Operation{ | ||
| description: "Subscribe to user updates", | ||
| operationId: "UserController.subscribe", | ||
| requestBody: %RequestBody{ | ||
| required: true, | ||
| content: %{ | ||
| "application/json" => %MediaType{ | ||
| schema: OpenApiSpexTest.Schemas.UserSubscribeRequest | ||
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR clarifies and tests the behaviour of SchemaResolved when it encounters schema modules with the same title.
See: #587, #566
It adds the following admonition block:
Alternatives Considered / Future Work
When a schema module we're resolving already exists in
components.schemasand itsx-structis different from the module being resolved we can log a warning. This can turn out to be very noisy this library currently logs very little.