OpenAPI-Specification
OpenAPI-Specification copied to clipboard
OAI
Define formats for URL templating with and without runtime expressions
PR #3234 proposes a url-template format, and is currently in discussion regarding the scope and naming of the format.
PR #3235 applied the format to the current schema, resulting in a debate over whether different formats are needed for URL templates that use runtime expressions vs those that do not.
There might also be other templating use cases in the Workflows spec that don't quite fit in either of these.
I'm filing this issue so we can track the various parts of the debate separately from the PRs, as PR #3235 overlaps with PR #3455 as well as having unresolved questions, so I am likely to close it.
Paging @MikeRalphson , @frankkilcommins
@handrews is there any work that needs to happen for 3.2 in that space? Maybe if you provided more context I could take this on now that I have more experience?
Also @handrews this one is listed under 3.2 in the discussion but is missing the milestone
@handrews can we close this issue now? I think this topic has a decent update in 3.2
@lornajane this is actually for adding to the format registry (something like format: oas-path-template, format: runtime-oas-path-template. It's stayed open because we did not have a formal definition for what that meant. Now we do, so someone (who is not me — I detest format) can figure out how to specify the formats and add them.
However, this can be done at any time and shouldn't be in the 3.2 milestone- I added it (apparently on auto-pilot) when @baywet brought it up, but it's not release-specific at all.
At the time I thought this was related to the server variables and path template improvements we've made. But it's not, at least not directly. So I think it can be pushed to a later time.
@baywet it depends on those improvements! Otherwise we didn't have a formal specification for what the proposed format values meant, which is why they were rejected and this issue was opened. So there is progress! But yes, we can finish the job in the format registry outside of the 3.2 release.