Skip to content

Fix: #2471. Clarify status code text. #2630

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Nov 18, 2021
Merged

Fix: #2471. Clarify status code text. #2630

merged 2 commits into from
Nov 18, 2021

Conversation

ioggstream
Copy link
Contributor

@ioggstream ioggstream commented Jun 25, 2021 •
edited
Loading

This PR

  • clarifies text around supported status codes.

Fixes: #2471

@ioggstream
Copy link
Contributor Author

@MikeRalphson as you requested :)

MikeRalphson
MikeRalphson previously requested changes Jul 5, 2021
View reviewed changes
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.

Thanks @ioggstream! Please could you retarget against versions/3.1.1.md on the v3.1.1-dev branch?

@ioggstream ioggstream changed the base branch from v3.1.0-dev to v3.1.1-dev July 5, 2021 09:51
@ioggstream ioggstream changed the base branch from v3.1.1-dev to v3.1.0-dev July 5, 2021 09:52
@ioggstream ioggstream changed the base branch from v3.1.0-dev to v3.1.1-dev July 5, 2021 09:57
@ioggstream ioggstream requested a review from MikeRalphson July 5, 2021 09:58
darrelmiller
darrelmiller reviewed Nov 11, 2021
View reviewed changes
@karenetheridge
Copy link
Member

This suggests the JSON Schema should be softened to support more than just [1-5][0-9][0-9]. Can you make that change as well? (schemas/v3.1/schema.json and .yaml)

@ioggstream
Copy link
Contributor Author

Hi @karenetheridge, maybe I'm missing something.
The IANA table covers the range [100; 599] as specified in https://httpwg.org/http-core/draft-ietf-httpbis-semantics-latest.html#status.codes

All valid status codes are within the range of 100 to 599, inclusive

iiuc all IANA status codes should comply with the above spec, and that there should be no change in https://github.com/OAI/OpenAPI-Specification/blob/main/schemas/v3.1/schema.yaml#L529

If its not the case, how would you modify the above file?

thx++, R

@darrelmiller
Copy link
Member

@karenetheridge There are no status codes in the IANA registry outside of the 100-599 range, so the regex in JSON Schema is fine.

@webron webron dismissed MikeRalphson’s stale review November 18, 2021 17:28

Change implemented.

@webron webron merged commit cfbfd36 into OAI:v3.1.1-dev Nov 18, 2021
@ioggstream ioggstream deleted the patch-4 branch November 18, 2021 21:45
@karenetheridge
Copy link
Member

The specification says SHOULD -- so doesn't this mean that it is still permissible for values to be outside that range (for some unusual usecase)?

@MikeRalphson MikeRalphson mentioned this pull request Feb 21, 2023
Closed
charjr pushed a commit to charjr/OpenAPI-Specification that referenced this pull request Apr 27, 2023
@ioggstream @darrelmiller @charjr
Fix: OAI#2471. Clarify status code text. (OAI#2630)
3fb95c5 
* Fix: OAI#2471. Clarify status code text.

* Update versions/3.1.1.md

Co-authored-by: Darrel <[email protected]>

Co-authored-by: Darrel <[email protected]>
charjr pushed a commit to charjr/OpenAPI-Specification that referenced this pull request Apr 27, 2023
@ioggstream @darrelmiller @charjr
Fix: OAI#2471. Clarify status code text. (OAI#2630)
e619163 
* Fix: OAI#2471. Clarify status code text.

* Update versions/3.1.1.md

Co-authored-by: Darrel <[email protected]>

Co-authored-by: Darrel <[email protected]>
lornajane added a commit to lornajane/OpenAPI-Specification that referenced this pull request Apr 9, 2024
@lornajane
Apply improved wording around status codes from 3.1.1 (original PR OA…
34e8b56 
…I#2630)
@lornajane lornajane mentioned this pull request Apr 9, 2024
Merged
darrelmiller pushed a commit that referenced this pull request Apr 18, 2024
@lornajane
Apply improved wording around status codes from 3.1.1 (original PR #2630
157f033 
) (#3699)
@handrews handrews mentioned this pull request Apr 25, 2024
Closed
@handrews handrews added this to the v3.1.1 milestone May 17, 2024
@handrews handrews added clarification requests to clarify, but not change, part of the spec http Supporting HTTP features and interactions labels May 17, 2024
@lornajane lornajane mentioned this pull request Aug 1, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@darrelmiller darrelmiller darrelmiller approved these changes

@MikeRalphson MikeRalphson Awaiting requested review from MikeRalphson

Assignees
No one assigned
Labels
clarification requests to clarify, but not change, part of the spec http Supporting HTTP features and interactions
Projects
None yet
Milestone
v3.1.1
Development

Successfully merging this pull request may close these issues.
6 participants
@ioggstream @karenetheridge @darrelmiller @MikeRalphson @webron @handrews