Fix 2XX, 4XX, 5XX responses #1251
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: bd72890 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
drwpow
commented
Jul 26, 2023
| @@ -29,9 +29,9 @@ export interface OperationObject { | |||
| responses: any; | |||
| } | |||
| export type HttpMethod = "get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace"; | |||
| export type OkStatus = 200 | 201 | 202 | 203 | 204 | 206 | 207; | |||
| export type OkStatus = 200 | 201 | 202 | 203 | 204 | 206 | 207 | "2XX"; | |||
There was a problem hiding this comment.
Random fact: the status codes are numbers because that’s what openapi-typescript actually exports. See #380
Deploying with
|
| Latest commit: |
bd72890
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://bf99acf2.openapi-ts.pages.dev |
| Branch Preview URL: | https://fix-ranges.openapi-ts.pages.dev |
drwpow
commented
Jul 26, 2023
| expect(generated).toBe(`{ | ||
| responses: { | ||
| /** @description OK */ | ||
| "2XX": { |
There was a problem hiding this comment.
😅 Glad this worked! Added a test just cuz I got scared
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Adds support for
2XX,4XX, and5XXresponses in schema, which is supported by the spec.Funny enough, I have never used this or seen this; just happened to skim over that definition and saw it was allowed. In
openapi-typescriptwe just skip right over this and never needed to parse it (still added a test just to be sure). Butopenapi-fetchrequires all valid status codes explicitly stated for TS inference to work.So for that one random person out there using this in your schema, this goes out to you 🥂
How to Review
Tests should pass.
Checklist
examples/directory updated (only applicable for openapi-typescript)