OpenAPI 3.0 use a different base URI for relative URLs in $ref
I'm new to OpenAPI 3.0, so let me know if I'm using bad practices.
Context: I'm building a flask app with Connexion to handle the REST routing and validation. Connexion loads an OpenAPI spec and maps to the handler methods. I've also submitted a PR to Connexion to enable $ref to use local relative file paths. Connexion loads the specs just fine.
The Issue: My issue is with the OpenAPI 3.0 specification itself. My spec files live in the directory /oas3/1.0beta/ and have relative filepaths, but the server base URL in the spec is /1.0beta/. The OpenAPI 3.0 specification states:
Relative references are resolved using the URLs defined in the Server Object as a Base URI.
Example
/oas3/1.0beta/spec.yaml:
openapi: 3.0.0
servers:
- description: Foo
url: https://foo.com/1.0beta/
info:
title: The Foo API!
version: "1.0beta"
paths:
/bar:
get:
summary: Gets a bar.
operationId: api_1_0beta.foo.bar_get
responses:
'200':
content:
application/json:
schema:
$ref: 'other_spec.yaml'
I want other_spec.yaml to resolve to /oas3/1.0beta/other_spec.yaml, but the OpenAPI specification (and therefore swagger tools/ui/etc) say that it resolves to /1.0beta/other_spec.yaml.
Is there a way/workaround to use a different base URI for relative $refs? Is it unreasonable to want different URL spaces for API paths and relative $refs?
swagger-ui openapi connexion
asked Nov 27 '18 at 23:12
Scott CrunkletonScott Crunkleton
568618
add a comment |
I'm new to OpenAPI 3.0, so let me know if I'm using bad practices.
Context: I'm building a flask app with Connexion to handle the REST routing and validation. Connexion loads an OpenAPI spec and maps to the handler methods. I've also submitted a PR to Connexion to enable $ref to use local relative file paths. Connexion loads the specs just fine.
The Issue: My issue is with the OpenAPI 3.0 specification itself. My spec files live in the directory /oas3/1.0beta/ and have relative filepaths, but the server base URL in the spec is /1.0beta/. The OpenAPI 3.0 specification states:
Relative references are resolved using the URLs defined in the Server Object as a Base URI.
Example
/oas3/1.0beta/spec.yaml:
openapi: 3.0.0
servers:
- description: Foo
url: https://foo.com/1.0beta/
info:
title: The Foo API!
version: "1.0beta"
paths:
/bar:
get:
summary: Gets a bar.
operationId: api_1_0beta.foo.bar_get
responses:
'200':
content:
application/json:
schema:
$ref: 'other_spec.yaml'
I want other_spec.yaml to resolve to /oas3/1.0beta/other_spec.yaml, but the OpenAPI specification (and therefore swagger tools/ui/etc) say that it resolves to /1.0beta/other_spec.yaml.
Is there a way/workaround to use a different base URI for relative $refs? Is it unreasonable to want different URL spaces for API paths and relative $refs?
swagger-ui openapi connexion
asked Nov 27 '18 at 23:12
Scott CrunkletonScott Crunkleton
568618
No answer, but lots of sympathy. I'm also struggling mightily to get relative refs to work with connexion. I see your PR in the long PR queue. Did you work out a way to break up your schema? AFAICT, there's no way to break schemas up with relative paths in the current connexion release.
– Reece
Feb 28 at 2:29
add a comment |
I'm new to OpenAPI 3.0, so let me know if I'm using bad practices.
Context: I'm building a flask app with Connexion to handle the REST routing and validation. Connexion loads an OpenAPI spec and maps to the handler methods. I've also submitted a PR to Connexion to enable $ref to use local relative file paths. Connexion loads the specs just fine.
The Issue: My issue is with the OpenAPI 3.0 specification itself. My spec files live in the directory /oas3/1.0beta/ and have relative filepaths, but the server base URL in the spec is /1.0beta/. The OpenAPI 3.0 specification states:
Relative references are resolved using the URLs defined in the Server Object as a Base URI.
Example
/oas3/1.0beta/spec.yaml:
openapi: 3.0.0
servers:
- description: Foo
url: https://foo.com/1.0beta/
info:
title: The Foo API!
version: "1.0beta"
paths:
/bar:
get:
summary: Gets a bar.
operationId: api_1_0beta.foo.bar_get
responses:
'200':
content:
application/json:
schema:
$ref: 'other_spec.yaml'
I want other_spec.yaml to resolve to /oas3/1.0beta/other_spec.yaml, but the OpenAPI specification (and therefore swagger tools/ui/etc) say that it resolves to /1.0beta/other_spec.yaml.
Is there a way/workaround to use a different base URI for relative $refs? Is it unreasonable to want different URL spaces for API paths and relative $refs?
swagger-ui openapi connexion
asked Nov 27 '18 at 23:12
Scott CrunkletonScott Crunkleton
568618
I'm new to OpenAPI 3.0, so let me know if I'm using bad practices.
Context: I'm building a flask app with Connexion to handle the REST routing and validation. Connexion loads an OpenAPI spec and maps to the handler methods. I've also submitted a PR to Connexion to enable $ref to use local relative file paths. Connexion loads the specs just fine.
The Issue: My issue is with the OpenAPI 3.0 specification itself. My spec files live in the directory /oas3/1.0beta/ and have relative filepaths, but the server base URL in the spec is /1.0beta/. The OpenAPI 3.0 specification states:
Relative references are resolved using the URLs defined in the Server Object as a Base URI.
Example
/oas3/1.0beta/spec.yaml:
openapi: 3.0.0
servers:
- description: Foo
url: https://foo.com/1.0beta/
info:
title: The Foo API!
version: "1.0beta"
paths:
/bar:
get:
summary: Gets a bar.
operationId: api_1_0beta.foo.bar_get
responses:
'200':
content:
application/json:
schema:
$ref: 'other_spec.yaml'
I want other_spec.yaml to resolve to /oas3/1.0beta/other_spec.yaml, but the OpenAPI specification (and therefore swagger tools/ui/etc) say that it resolves to /1.0beta/other_spec.yaml.
Is there a way/workaround to use a different base URI for relative $refs? Is it unreasonable to want different URL spaces for API paths and relative $refs?
swagger-ui openapi connexion
swagger-ui openapi connexion
asked Nov 27 '18 at 23:12
Scott CrunkletonScott Crunkleton
568618
asked Nov 27 '18 at 23:12
Scott CrunkletonScott Crunkleton
568618
asked Nov 27 '18 at 23:12
Scott CrunkletonScott Crunkleton
568618
asked Nov 27 '18 at 23:12
Scott CrunkletonScott Crunkleton
568618
asked Nov 27 '18 at 23:12
Scott CrunkletonScott Crunkleton
568618
568618
No answer, but lots of sympathy. I'm also struggling mightily to get relative refs to work with connexion. I see your PR in the long PR queue. Did you work out a way to break up your schema? AFAICT, there's no way to break schemas up with relative paths in the current connexion release.
– Reece
Feb 28 at 2:29
add a comment |
No answer, but lots of sympathy. I'm also struggling mightily to get relative refs to work with connexion. I see your PR in the long PR queue. Did you work out a way to break up your schema? AFAICT, there's no way to break schemas up with relative paths in the current connexion release.
– Reece
Feb 28 at 2:29
No answer, but lots of sympathy. I'm also struggling mightily to get relative refs to work with connexion. I see your PR in the long PR queue. Did you work out a way to break up your schema? AFAICT, there's no way to break schemas up with relative paths in the current connexion release.
– Reece
Feb 28 at 2:29
No answer, but lots of sympathy. I'm also struggling mightily to get relative refs to work with connexion. I see your PR in the long PR queue. Did you work out a way to break up your schema? AFAICT, there's no way to break schemas up with relative paths in the current connexion release.
– Reece
Feb 28 at 2:29
add a comment |
0
active
oldest
votes
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53509663%2fopenapi-3-0-use-a-different-base-uri-for-relative-urls-in-ref%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
0
active
oldest
votes
0
active
oldest
votes
active
oldest
votes
active
oldest
votes
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53509663%2fopenapi-3-0-use-a-different-base-uri-for-relative-urls-in-ref%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
No answer, but lots of sympathy. I'm also struggling mightily to get relative refs to work with connexion. I see your PR in the long PR queue. Did you work out a way to break up your schema? AFAICT, there's no way to break schemas up with relative paths in the current connexion release.
– Reece
Feb 28 at 2:29