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

Specify that tag names are case-sensitive #3999

Closed
wants to merge 1 commit into from

Conversation

rvedotrc
Copy link

@rvedotrc rvedotrc commented Aug 6, 2024

It's not currently stated whether tags are case-sensitive or -insensitive (principally, for matching a tag on an Operation to a Tag object). This PR seeks to rectify that.

Or, maybe we should define them as case insensitive.

Copy link
Contributor

@ralfhandl ralfhandl left a comment

Choose a reason for hiding this comment

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

Checked with a popular OAD display tool, and it treats tags case-sensitive.

@ralfhandl ralfhandl requested a review from a team August 7, 2024 07:15
@ralfhandl
Copy link
Contributor

@tsc: how are typical tools dealing with tags that differ only in case?

@handrews
Copy link
Member

handrews commented Aug 8, 2024

@ralfhandl We already require them to be case-sensitive. This is a bit more clear in 3.1.1 and 3.0.4 where there is now an "HTTP and Case-Sensitivity" section noting that everything is case-sensitive unless it directly maps to an HTTP concept that is defined as case-insensitive. Tags clearly are not in the HTTP category, so they are case-sensitive.

@ralfhandl
Copy link
Contributor

ralfhandl commented Aug 9, 2024

@handrews How about renaming the new section to just "Case Sensitivity"? That would draw more attention, and we still can cover HTTP in the unchanged section text?

### HTTP and Case Sensitivity
As most field names and values in the OpenAPI Specification are case-sensitive, this document endeavors to call out any case-insensitive names and values.
However, the case sensitivity of field names and values that map directly to HTTP concepts follow the case sensitivity rules of HTTP, even if this document does not make a note of every concept.

I'll add that as a proposal to #4001

@ralfhandl
Copy link
Contributor

@rvedotrc If this new section also covers your concern, then please close this PR.

@rvedotrc rvedotrc closed this Aug 9, 2024
@handrews
Copy link
Member

handrews commented Aug 9, 2024

@ralfhandl I'd support that rename!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants