github.com/snyk/vervet/v5@v5.11.1-0.20240202085829-ad4dd7fb6101/testdata/resources/_examples/hello-world/2021-06-07/spec.yaml (about)

     1  openapi: 3.0.3
     2  x-snyk-api-stability: experimental
     3  info:
     4    title: Registry
     5    version: 3.0.0
     6  servers:
     7    - url: /api/v3
     8      description: Snyk Registry
     9  paths:
    10    /examples/hello-world/{id}:
    11      get:
    12        description: Get a single result from the hello-world example
    13        operationId: helloWorldGetOne
    14        parameters:
    15          - { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/parameters/version.yaml#/Version' }
    16          - { $ref: '../../../schemas/parameters/pagination.yaml#/Pagination' }
    17          - name: id
    18            description: The id of the hello-world example entity to be retrieved.
    19            in: path
    20            required: true
    21            schema:
    22              type: string
    23        responses:
    24          '400': { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/responses/400.yaml#/400' }
    25          '401': { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/responses/401.yaml#/401' }
    26          '404': { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/responses/404.yaml#/404' }
    27          '500': { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/responses/500.yaml#/500' }
    28          '200':
    29            description: 'A hello world entity being requested is returned'
    30            headers:
    31              snyk-version-requested: { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/headers/headers.yaml#/VersionRequestedResponseHeader' }
    32              snyk-version-served: { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/headers/headers.yaml#/VersionServedResponseHeader' }
    33              snyk-request-id: { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/headers/headers.yaml#/RequestIdResponseHeader' }
    34            content:
    35              application/vnd.api+json:
    36                schema:
    37                  type: object
    38                  properties:
    39                    jsonapi: { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/common.yaml#/JsonApi' }
    40                    links: { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/common.yaml#/Links' }
    41                    data: { $ref: '#/components/schemas/HelloWorld'}
    42                  required: ['jsonapi', 'data', 'links']
    43                  additionalProperties: false
    44  
    45  components:
    46    schemas:
    47      HelloWorld:
    48        type: object
    49        properties:
    50          type:
    51            type: string
    52          id:
    53            type: string
    54            format: uuid
    55          attributes:
    56            type: object
    57            properties:
    58              message:
    59                type: string
    60              requestSubject:
    61                type: object
    62                properties:
    63                  publicId:
    64                    type: string
    65                    format: uuid
    66                  type:
    67                    type: string
    68                  clientId:
    69                    type: string
    70                    format: uuid
    71                required: ['publicId', 'type' ]
    72                additionalProperties: false
    73            required: ['message', 'requestSubject']
    74            additionalProperties: false
    75        required: ['type', 'id', 'attributes']
    76        additionalProperties: false