OpenAPI 2 security and formatting warnings

1
swagger: '2.0'
2
#...
3
security:
4
  - OAuth2:
5
    - read
6
    - write
7
securityDefinitions:
8
  OAuth2:
9
    type: oauth2
10
    flow: accessCode
11
    scopes:
12
      read: read object
13
      write: writes object
14
    authorizationUrl: https://example.com/authorize
15
    tokenUrl: https://example.com/token

1
swagger: '2.0'
2
#...
3
paths:
4
  '/user':
5
    get:
6
      summary: 'Sample endpoint: Returns details about a particular user'
7
      operationId: listUser
8
      security:
9
        - OAuth2:
10
          - read
11
          - write
12
securityDefinitions:
13
  OAuth2:
14
    type: oauth2
15
    flow: accessCode
16
    scopes:
17
      read: read object
18
      write: writes object
19
    authorizationUrl: https://example.com/authorize
20
    tokenUrl: https://example.com/token

1
swagger: '2.0'
2
#...
3
securityDefinitions:
4
  basicAuth:
5
    type: basic
6
security:
7
    - basicAuth: []

1
swagger: '2.0'
2
#...
3
securityDefinitions:
4
  basicAuth:
5
    type: basic
6
security:
7
    - basicAuth: []

1
swagger: '2.0'
2
#...
3
securityDefinitions:
4
  basicAuth:
5
    type: basic
6
security:
7
    - basicAuth: []

1
swagger: '2.0'
2
#...
3
securityDefinitions:
4
  basicAuth:
5
    type: basic

1
swagger: '2.0'
2
#...
3
securityDefinitions:
4
  basicAuth:
5
    type: basic

1
swagger: '2.0'
2
#...
3
securityDefinitions:
4
  basicAuth:
5
    type: basic
6
security:
7
    - basicAuth: []

1
swagger: '2.0'
2
#...
3
paths:
4
  /user:
5
    get:
6
      description: 'Returns details about a particular user'
7
      security:
8
          - basicAuth: []
9
      #...
10
securityDefinitions:
11
  basicAuth:
12
    type: basic

1
swagger: '2.0'
2
#...
3
paths:
4
  /user:
5
    get:
6
      description: 'Returns details about a particular user'
7
      security:
8
          - basicAuth: []
9
      #...
10
securityDefinitions:
11
  basicAuth:
12
    type: basic

1
swagger: '2.0'
2
#...
3
paths:
4
  /user:
5
    get:
6
      description: 'Sample endpoint: Returns details about a particular user'
7
      security:
8
          - basicAuth: []
9
      #...
10
securityDefinitions:
11
  basicAuth:
12
    type: basic

1
swagger: '2.0'
2
#...
3
host: 'example.com'
4
schemes:
5
  - https
6
securityDefinitions:
7
  OAuth2:
8
    type: oauth2
9
    flow: accessCode
10
    authorizationUrl: https://my.auth.example.com/
11
    tokenUrl: https://my.token.example.com/
12
security:
13
 - OAuth2: []

1
swagger: '2.0'
2
#...
3
host: 'example.com'
4
schemes:
5
  - https
6
securityDefinitions:
7
  apiKeyAuth:
8
    type: apiKey
9
    name: api_key
10
    in: header
11
security:
12
  - apiKeyAuth: []

1
swagger: '2.0'
2
#...
3
host: 'example.com'
4
schemes:
5
  - https
6
securityDefinitions:
7
  basicAuth:
8
    type: basic
9
security:
10
 - basicAuth: []

1
swagger: '2.0'
2
#...
3
host: 'example.com'
4
schemes:
5
  - https
6
#...

1
swagger: '2.0'
2
#...
3
host: 'example.com'
4
paths:
5
  '/user':
6
    get:
7
      summary: 'Sample endpoint: Returns details about a particular user'
8
      schemes:
9
          - https
10
      security:
11
          - OAuth2: []
12
      #...
13
securityDefinitions:
14
  OAuth2:
15
    type: oauth2
16
    flow: accessCode
17
    authorizationUrl: https://my.auth.example.com/
18
    tokenUrl: https://my.token.example.com/

1
swagger: '2.0'
2
#...
3
host: 'example.com'
4
paths:
5
  '/user':
6
    get:
7
      summary: 'Sample endpoint: Returns details about a particular user'
8
      schemes:
9
          - https
10
      security:
11
          - apiKeyAuth: []
12
      #...
13
securityDefinitions:
14
  apiKeyAuth:
15
    type: apiKey
16
    name: api_key
17
    in: header

1
swagger: '2.0'
2
#...
3
host: 'example.com'
4
paths:
5
  '/user':
6
    get:
7
      summary: 'Sample endpoint: Returns details about a particular user'
8
      schemes:
9
          - https
10
      security:
11
          - BasicAuth: []
12
      #...
13
securityDefinitions:
14
  BasicAuth:
15
    type: basic

1
swagger: '2.0'
2
#...
3
host: 'example.com'
4
paths:
5
  '/user':
6
    get:
7
      summary: 'Sample endpoint: Returns details about a particular user'
8
      schemes:
9
          - https
10
      #...

1
swagger: '2.0'
2
#...
3
securityDefinitions:
4
  OAuth2:
5
    type: oauth2
6
    flow: accessCode
7
    #...
8
    authorizationUrl: https://example.com/authorize

1
swagger: '2.0'
2
#...
3
securityDefinitions:
4
  OAuth2:
5
    type: oauth2
6
    flow: accessCode
7
    #...
8
    tokenUrl: https://example.com/token

1
swagger: '2.0'
2
paths: {}
3
consumes:
4
  - application/json
5
produces:
6
  - application/json

1
swagger: '2.0'
2
paths: {}
3
produces:
4
  - application/json
5
...

1
swagger: '2.0'
2
paths:
3
  /user/{userId}:
4
    get:
5
      produces:
6
        - application/json

1
swagger: '2.0'
2
paths:
3
  /user/{userId}:
4
    get:
5
      produces:
6
        - application/json
7
  ...
8
...

1
swagger: '2.0'
2
paths: {}
3
consumes:
4
  - application/json

1
swagger: '2.0'
2
paths: {}
3
consumes:
4
  - application/json
5
...

1
swagger: '2.0'
2
paths:
3
  /user/{userId}:
4
    put:
5
      consumes:
6
        - application/json

1
swagger: '2.0'
2
paths:
3
  /user/{userId}:
4
    put:
5
      consumes:
6
        - application/json
7
  ...
8
...

1
swagger: '2.0'
2
#...
3
securityDefinitions:
4
  OAuth2:
5
    type: oauth2
6
    flow: accessCode
7
    authorizationUrl: https://my.auth.example.com/
8
    tokenUrl: https://my.token.example.com/
9
    scopes:
10
      write: modify data
11
      read: read data

1
swagger: '2.0'
2
#...
3
securityDefinitions:
4
  OAuth2:
5
    type: oauth2
6
    flow: accessCode
7
    authorizationUrl: https://my.auth.example.com/
8
    tokenUrl: https://my.token.example.com/
9
    scopes:
10
      write: modify data
11
      read: read data

1
swagger: '2.0'
2
info:
3
  title: An API name
4
  version: '1.0'
5
  description: An API description

1
swagger: '2.0'
2
info:
3
  title: An API name
4
  version: '1.0'
5
  license:
6
    name: Apache 2.0
7
    url: https://opensource.org/licenses/Apache-2.0

1
swagger: '2.0'
2
info:
3
  title: An API name
4
  version: '1.0'
5
  license:
6
    name: Apache 2.0
7
    url: https://opensource.org/licenses/Apache-2.0

1
swagger: '2.0'
2
info:
3
  title: An API name
4
  version: '1.0'
5
  termsOfService: https://example.com/tos

1
swagger: '2.0'
2
info:
3
  title: An API name
4
  version: '1.0'
5
  contact:
6
    email: support@example.com
7
    url: https://example.com/support

1
swagger: '2.0'
2
info:
3
  title: An API name
4
  version: '1.0'
5
  contact:
6
    name: A contact name

1
swagger: '2.0'
2
info:
3
  title: An API name
4
  version: '1.0'
5
  contact:
6
    email: contact@example.com

1
swagger: '2.0'
2
info:
3
  title: An API name
4
  version: '1.0'
5
  contact:
6
    url: https://example.com/support

1
swagger: '2.0'
2
info:
3
  title: An API name
4
  version: '1.0'
5
  contact:
6
    email: contact@example.com

1
swagger: '2.0'
2
info:
3
  title: An API name
4
  version: '1.0'
5
  contact:
6
    url: https://example.com/support

1
swagger: '2.0'
2
# ...
3
paths:
4
  '/resources':

1
swagger: '2.0'
2
# ...
3
paths:
4
  /resources:
5
    get:
6
      summary: A GET operation summary

1
swagger: '2.0'
2
# ...
3
paths:
4
  /resources:
5
    get:
6
      summary: A GET operation summary

1
swagger: '2.0'
2
# ...
3
paths:
4
  /resources:
5
    get:
6
      description: A GET operation description

1
swagger: '2.0'
2
# ...
3
paths:
4
  /resources:
5
    get:
6
      parameters:
7
        - name: status
8
        description: filters resources on their status
9
        in: query
10
        type: string

1
swagger: '2.0'
2
# ...
3
paths:
4
  /resources:
5
    post:
6
      parameters:
7
        - in: body
8
          name: body
9
          schema:
10
            type: object

1
swagger: '2.0'
2
# ...
3
paths:
4
  /resources:
5
    put:
6
      parameters:
7
        - in: body
8
          name: body
9
          schema:
10
            type: object

1
swagger: '2.0'
2
# ...
3
paths:
4
  /resources:
5
    patch:
6
      parameters:
7
        - in: body
8
          name: body
9
          schema:
10
            type: object

1
swagger: '2.0'
2
# ...
3
paths:
4
  /resources:
5
    post:
6
      parameters:
7
        - in: body
8
          name: body
9
          schema:
10
            type: object
11
            example:
12
              aProperty: example value

1
swagger: '2.0'
2
# ...
3
paths:
4
  /resources:
5
    get:
6
      responses:
7
        '200':
8
          description: A success response

1
swagger: '2.0'
2
# ...
3
paths:
4
  /resources:
5
    get:
6
      responses:
7
        '500':
8
          description: A server error response

1
swagger: '2.0'
2
# ...
3
paths:
4
  /resources:
5
    get:
6
      responses:
7
        '200':
8
          description: A success response
9
          examples:
10
            'application/json':
11
              aProperty: example value

1
swagger: '2.0'
2
#...
3
paths:
4
  /resources:
5
    delete:
6
      responses:
7
        '204':
8
          description: a success response

1
swagger: '2.0'
2
# ...
3
paths:
4
  /resources:
5
    post:
6
      parameters:
7
        - name: a resource to create
8
        in: body
9
        schema:
10
          $ref: '#/definitions/ResourceCreate'
11
      responses:
12
        '201':
13
          description: a post success response
14
          schema:
15
            $ref: '#/definitions/Resource'
16
definitions:
17
  ResourceCreate:
18
    type: object
19
  Resource:
20
    type: object

1
swagger: '2.0'
2
# ...
3
definitions:
4
  aReusableSchema:
5
    description: a reusable schema description
6
    type: object

1
swagger: '2.0'
2
#...
3
paths:
4
  /resources:
5
    get:
6
      responses:
7
        '200':
8
          description: a success response
9
          schema:
10
            properties:
11
              aProperty:
12
                description: a property description
13
                type: string

1
swagger: '2.0'
2
# ...
3
definitions:
4
  anObject:
5
    properties:
6
      aList:
7
        type: array
8
        minItems: 1
9
        maxItems: 100
10
        items:
11
          type: object