github.com/snyk/vervet/v5@v5.11.1-0.20240202085829-ad4dd7fb6101/testdata/resources/_examples/hello-world/2021-06-01/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  tags:
    10    - name: Something
    11      description: Something
    12  paths:
    13    /examples/hello-world/{id}:
    14      get:
    15        description: Get a single result from the hello-world example
    16        operationId: helloWorldGetOne
    17        parameters:
    18          - { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/parameters/version.yaml#/Version' }
    19          - { $ref: '../../../schemas/parameters/pagination.yaml#/Pagination' }
    20          - name: id
    21            description: The id of the hello-world example entity to be retrieved.
    22            in: path
    23            required: true
    24            schema:
    25              type: string
    26        responses:
    27          '400': { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/responses/400.yaml#/400' }
    28          '401': { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/responses/401.yaml#/401' }
    29          '404': { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/responses/404.yaml#/404' }
    30          '500': { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/responses/500.yaml#/500' }
    31          '200':
    32            description: 'A hello world entity being requested is returned'
    33            headers:
    34              snyk-version-requested: { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/headers/headers.yaml#/VersionRequestedResponseHeader' }
    35              snyk-version-served: { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/headers/headers.yaml#/VersionServedResponseHeader' }
    36              snyk-request-id: { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/headers/headers.yaml#/RequestIdResponseHeader' }
    37            content:
    38              application/vnd.api+json:
    39                schema:
    40                  type: object
    41                  properties:
    42                    jsonapi: { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/common.yaml#/JsonApi' }
    43                    links: { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/common.yaml#/Links' }
    44                    data: { $ref: '#/components/schemas/HelloWorld'}
    45                  required: ['jsonapi', 'data', 'links']
    46                  additionalProperties: false
    47  
    48  components:
    49    schemas:
    50      HelloWorld:
    51        type: object
    52        properties:
    53          type:
    54            type: string
    55          id:
    56            type: string
    57            format: uuid
    58          attributes:
    59            type: object
    60            properties:
    61              message:
    62                type: string
    63              requestSubject:
    64                type: object
    65                properties:
    66                  publicId:
    67                    type: string
    68                    format: uuid
    69                  type:
    70                    type: string
    71                  clientId:
    72                    type: string
    73                    format: uuid
    74                required: ['publicId', 'type' ]
    75                additionalProperties: false
    76            required: ['message', 'requestSubject']
    77            additionalProperties: false
    78        required: ['type', 'id', 'attributes']
    79        additionalProperties: false