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

Add templated-url format to the registry #3234

Closed

Conversation

MikeRalphson
Copy link
Member

As discussed with @jdesrosiers on Slack

@handrews
Copy link
Member

handrews commented Apr 6, 2023

(pardon muddled thoughts - I'm recovering from COVID) is there a reason to not make this oas-templated-url? There might be a wide range of formats that fit the vague description here, making the format difficult to support.

@MikeRalphson
Copy link
Member Author

There's no reason not to, is it just for clarity? AsyncAPI might use something very similar though.

@handrews
Copy link
Member

handrews commented Apr 7, 2023

trying to avoid a repeat of decimal where there are different meanings depending on context

@handrews
Copy link
Member

handrews commented Apr 7, 2023

i think the question to ask is: what guarantees can tools assume/implement when they see this format? Currently, not much. URI + { and }, but that is a broader constraint than OAS defines - OAS puts constraints on what parts of a URI can be replaced by a variable, and might constrain the variable syntax (I can't recall)

@handrews
Copy link
Member

See also #3256 (Formally define templating behavior)

@handrews
Copy link
Member

I think if we make this oas3-templated-url we could merge it. That avoids confusion with other URL templating systems, of which there are many, including ones that differ across OAS versions.

@handrews handrews requested a review from a team January 26, 2024 22:35
@handrews
Copy link
Member

Also, I think this needs rebasing.

@handrews
Copy link
Member

Since Mike's not available to rebase and discuss this, and we're already tracking the need for a format for this in #3530 (which already links to this PR), I'm just going to close this. When someone is available to figure it out they can submit a new PR.

@handrews handrews closed this Feb 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants