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

- adds a base64url format description #3184

Merged
merged 1 commit into from
Mar 16, 2023

Conversation

baywet
Copy link
Contributor

@baywet baywet commented Mar 3, 2023

related #3167

@handrews
Copy link
Member

handrews commented Mar 6, 2023

@baywet I think you need to update this to remove the deprecated version info.

I'm also wondering if, now that we have definitively settled on byte rather than base64, if it makes sense to align with RFC 4648 terminology for this, or call it byte-url or something. Neither feels very satisfactory to me.

@baywet
Copy link
Contributor Author

baywet commented Mar 6, 2023

Can you expand on why do you think we should remove the deprecated aspect please? I might have missed part of the conversation here.

If it were only up to me, byte would be base64 and base64url would be base64url. byte only being an alias to byte64 for compatibility reasons. Those different names are simply adding confusion IMHO.

@handrews
Copy link
Member

handrews commented Mar 6, 2023

Edit to my previous comment: formats are kebab-case so byte-url, not byteUrl

Re: deprecated_note — see #3167 (comment)

In #3174 I suggested having a base64 alias for byte but we discussed it in the last call and decided not to do that (as seen in #3182). So we're stuck with byte.

@baywet baywet force-pushed the feature/base64url-format branch from c83d732 to 50380dc Compare March 7, 2023 13:28
@baywet
Copy link
Contributor Author

baywet commented Mar 13, 2023

@handrews so are we good with this PR as is or do you suggest we make other changes?

@handrews
Copy link
Member

I'm still feeling meh about whether to use base64url for compatibility with OAS 3.1 vs byte-url for compatibility with OAS 3.0, the actual targeted version here. As much as I dislike byte, it's what we're stuck with and this is a URL-safe version of it. Although I suspect that very few tools will implement support for this so I'm not sure how much it matters.

@MikeRalphson, @darrelmiller, anyone else - any preference for base64url vs byte-url in the context of OpenAPI 3.0?

@MikeRalphson
Copy link
Member

+1 for base64url, let's not be held back by our past missteps.

@handrews
Copy link
Member

@MikeRalphson thanks - in that case this looks good to go.

Copy link
Member

@MikeRalphson MikeRalphson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@baywet baywet mentioned this pull request Mar 14, 2023
@darrelmiller darrelmiller merged commit 94c8821 into OAI:gh-pages Mar 16, 2023
@baywet baywet deleted the feature/base64url-format branch March 16, 2023 14:09
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.

4 participants