Change response codes to strings (#1112) (#1990)

Fixes #1112 . Changes proposed in this pull request: - Convert response keys from ints to strings
spec-first · Nov 9, 2024 · a48949c · a48949c
1 parent e6d1234
commit a48949c
Show file tree

Hide file tree

Showing 37 changed files with 158 additions and 158 deletions.
diff --git a/README.md b/README.md
@@ -169,7 +169,7 @@ The operation described in your specification is automatically linked to your Py
        post:
          operationId: run.post_greeting
          responses:
-           200:
+           '200':
              content:
                text/plain:
                  schema:

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -142,7 +142,7 @@ register an API defined by an OpenAPI (or Swagger) specification.
                 post:
                   operationId: run.post_greeting
                   responses:
-                    200:
+                    '200':
                       description: "Greeting response"
                       content:
                         text/plain:

diff --git a/examples/basicauth/spec/swagger.yaml b/examples/basicauth/spec/swagger.yaml
@@ -9,7 +9,7 @@ paths:
       summary: Return secret string
       operationId: app.get_secret
       responses:
-        200:
+        '200':
           description: secret response
           schema:
             type: string

diff --git a/examples/frameworks/spec/openapi.yaml b/examples/frameworks/spec/openapi.yaml
@@ -13,7 +13,7 @@ paths:
       description: Generates a greeting message.
       operationId: post_greeting
       responses:
-        200:
+        '200':
           description: greeting response
           content:
             text/plain:

diff --git a/examples/frameworks/spec/swagger.yaml b/examples/frameworks/spec/swagger.yaml
@@ -15,7 +15,7 @@ paths:
       produces:
         - text/plain;
       responses:
-        200:
+        '200':
           description: greeting response
           schema:
             type: string

diff --git a/examples/helloworld/spec/openapi.yaml b/examples/helloworld/spec/openapi.yaml
@@ -13,7 +13,7 @@ paths:
       description: Generates a greeting message.
       operationId: hello.post_greeting
       responses:
-        200:
+        '200':
           description: greeting response
           content:
             text/plain:

diff --git a/examples/helloworld/spec/swagger.yaml b/examples/helloworld/spec/swagger.yaml
@@ -15,7 +15,7 @@ paths:
       produces:
         - text/plain;
       responses:
-        200:
+        '200':
           description: greeting response
           schema:
             type: string

diff --git a/examples/helloworld_async/spec/openapi.yaml b/examples/helloworld_async/spec/openapi.yaml
@@ -13,7 +13,7 @@ paths:
       description: Generates a greeting message.
       operationId: hello.post_greeting
       responses:
-        200:
+        '200':
           description: greeting response
           content:
             text/plain:

diff --git a/examples/helloworld_async/spec/swagger.yaml b/examples/helloworld_async/spec/swagger.yaml
@@ -12,7 +12,7 @@ paths:
       description: Generates a greeting message.
       operationId: hello.post_greeting
       responses:
-        200:
+        '200':
           description: greeting response
           schema:
             type: string

diff --git a/examples/oauth2/spec/mock_tokeninfo.yaml b/examples/oauth2/spec/mock_tokeninfo.yaml
@@ -10,7 +10,7 @@ paths:
       summary: OAuth2 token info
       operationId: mock_tokeninfo.get_tokeninfo
       responses:
-        200:
+        '200':
           description: Token info object
           schema:
             type: object

diff --git a/examples/oauth2/spec/openapi.yaml b/examples/oauth2/spec/openapi.yaml
@@ -13,7 +13,7 @@ paths:
       summary: Return secret string
       operationId: app.get_secret
       responses:
-        200:
+        '200':
           description: secret response
           content:
             'text/plain':

diff --git a/examples/oauth2/spec/swagger.yaml b/examples/oauth2/spec/swagger.yaml
@@ -12,7 +12,7 @@ paths:
       summary: Return secret string
       operationId: app.get_secret
       responses:
-        200:
+        '200':
           description: secret response
           schema:
             type: string

diff --git a/examples/oauth2_local_tokeninfo/spec/openapi.yaml b/examples/oauth2_local_tokeninfo/spec/openapi.yaml
@@ -13,7 +13,7 @@ paths:
       summary: Return secret string
       operationId: app.get_secret
       responses:
-        200:
+        '200':
           description: secret response
           content:
             text/plain:

diff --git a/examples/oauth2_local_tokeninfo/spec/swagger.yaml b/examples/oauth2_local_tokeninfo/spec/swagger.yaml
@@ -12,7 +12,7 @@ paths:
       summary: Return secret string
       operationId: app.get_secret
       responses:
-        200:
+        '200':
           description: secret response
           schema:
             type: string

diff --git a/examples/sqlalchemy/spec/swagger.yaml b/examples/sqlalchemy/spec/swagger.yaml
@@ -24,7 +24,7 @@ paths:
           minimum: 0
           default: 100
       responses:
-        200:
+        '200':
           description: Return pets
           schema:
             type: array
@@ -38,11 +38,11 @@ paths:
       parameters:
         - $ref: '#/parameters/pet_id'
       responses:
-        200:
+        '200':
           description: Return pet
           schema:
             $ref: '#/definitions/Pet'
-        404:
+        '404':
           description: Pet does not exist
     put:
       tags: [Pets]
@@ -55,9 +55,9 @@ paths:
           schema:
             $ref: '#/definitions/Pet'
       responses:
-        200:
+        '200':
           description: Pet updated
-        201:
+        '201':
           description: New pet created
     delete:
       tags: [Pets]
@@ -66,9 +66,9 @@ paths:
       parameters:
         - $ref: '#/parameters/pet_id'
       responses:
-        204:
+        '204':
           description: Pet was deleted
-        404:
+        '404':
           description: Pet does not exist
 
 

diff --git a/tests/fixtures/bad_operations/swagger.yaml b/tests/fixtures/bad_operations/swagger.yaml
@@ -11,21 +11,21 @@ paths:
     get:
       operationId: no.module.or.function
       responses:
-        200:
+        '200':
           description: greeting response
           schema:
             type: object
     put:
       # operationId: XXX completely missing
       responses:
-        200:
+        '200':
           description: greeting response
           schema:
             type: object
     post:
       operationId: fakeapi.module_with_error.something
       responses:
-        200:
+        '200':
           description: greeting response
           schema:
             type: object
diff --git a/tests/fixtures/bad_specs/swagger.yaml b/tests/fixtures/bad_specs/swagger.yaml
@@ -17,7 +17,7 @@ paths:
           type: integer
           default: somestring
       responses:
-        200:
+        '200':
           description: search
           schema:
             type: object
diff --git a/tests/fixtures/datetime_support/openapi.yaml b/tests/fixtures/datetime_support/openapi.yaml
@@ -12,7 +12,7 @@ paths:
       summary: Generate data with date time
       operationId: fakeapi.hello.get_datetime
       responses:
-        200:
+        '200':
           description: date time example
           content:
             application/json:
@@ -29,7 +29,7 @@ paths:
       summary: Generate data with date
       operationId: fakeapi.hello.get_date
       responses:
-        200:
+        '200':
           description: date example
           content:
             application/json:
@@ -46,7 +46,7 @@ paths:
       summary: Generate data with uuid
       operationId: fakeapi.hello.get_uuid
       responses:
-        200:
+        '200':
           description: uuid example
           content:
             application/json:

diff --git a/tests/fixtures/datetime_support/swagger.yaml b/tests/fixtures/datetime_support/swagger.yaml
@@ -11,7 +11,7 @@ paths:
     get:
       operationId: fakeapi.hello.get_datetime
       responses:
-        200:
+        '200':
           description: date time example
           schema:
             type: object
@@ -25,7 +25,7 @@ paths:
     get:
       operationId: fakeapi.hello.get_date
       responses:
-        200:
+        '200':
           description: date example
           schema:
             type: object
@@ -40,7 +40,7 @@ paths:
       summary: Generate data with uuid
       operationId: fakeapi.hello.get_uuid
       responses:
-        200:
+        '200':
           description: uuid example
           schema:
             type: object

diff --git a/tests/fixtures/default_param_error/swagger.yaml b/tests/fixtures/default_param_error/swagger.yaml
@@ -12,7 +12,7 @@ paths:
       summary: Default value does not match the param type
       operationId: fakeapi.hello.test_default_mismatch_definition
       responses:
-        200:
+        '200':
           description: OK
       parameters:
         - name: age