v3.1 Schema bugfix: Update URI fields to use uri-reference or uri where appropriate #2586
Conversation
This file contains 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
JSON Schema can't express this constraint
jdesrosiers
force-pushed
the
schema31-ref-uri-reference
branch
from
fc863ac to
5d85f3c
Compare
MikeRalphson
approved these changes
May 24, 2021
char0n
pushed a commit
to swaggerexpert/OpenAPI-Specification
that referenced
this pull request
Jul 5, 2021
…re appropriate (OAI#2586) * Fix typo in v3.1 schema tests * Remove v3.1 schema test for server variable JSON Schema can't express this constraint * v3.1 Schema fix. $ref should be a uri-reference
davishmcclurg
added a commit
to davishmcclurg/OpenAPI-Specification
that referenced
this pull request
Nov 20, 2023
`Server.url` and `Link.operationRef` both allow variable substitution
with {brackets}, which means they're not always valid URI references.
For example, the [current specification][0] shows
`https://{username}.gigantic-server.com:{port}/{basePath}` as a Server
Object `url`, but it's not a valid URI reference because the host
includes curly brackets.
[`operationRef`][1] similarly includes
`https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get`
as an example that isn't valid using the `uri-reference` format.
I looked into the other uses of `uri-reference` and they seemed ok.
Related:
- OAI#2586
- OAI#3235
- OAI#3256
- davishmcclurg/json_schemer#158
[0]: https://spec.openapis.org/oas/v3.1.0#server-object-example
[1]: https://spec.openapis.org/oas/v3.1.0#operationref-examples
notEthan
pushed a commit
to notEthan/scorpio
that referenced
this pull request
Dec 4, 2024
`Server.url` and `Link.operationRef` both allow variable substitution
with {brackets}, which means they're not always valid URI references.
For example, the [current specification][0] shows
`https://{username}.gigantic-server.com:{port}/{basePath}` as a Server
Object `url`, but it's not a valid URI reference because the host
includes curly brackets.
[`operationRef`][1] similarly includes
`https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get`
as an example that isn't valid using the `uri-reference` format.
I looked into the other uses of `uri-reference` and they seemed ok.
Related:
- OAI/OpenAPI-Specification#2586
- OAI/OpenAPI-Specification#3235
- OAI/OpenAPI-Specification#3256
- davishmcclurg/json_schemer#158
[0]: https://spec.openapis.org/oas/v3.1.0#server-object-example
[1]: https://spec.openapis.org/oas/v3.1.0#operationref-examples
(cherry picked from commit 5f765f29e3c12dcab370f5155fe21c6895a8ac5e)
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.
Reported by #2584
The
uriformat was being used for all URIs. However,uridoesn't allow relative URIs. The format should beuri-referencefor any URI that allows a relative URI. I went through the spec and the schema and made sure that every URI field is using the appropriate format.I also fixed some things related to the schema tests. The "default" field of a server variable must be one of the values in the "enum" field. JSON Schema can't express that constraint, so I removed the tests. I also fixed a typo in file name.