github.com/snyk/vervet/v5@v5.11.1-0.20240202085829-ad4dd7fb6101/testdata/output/2021-06-01~experimental/spec.yaml (about)

     1  # OpenAPI spec generated by vervet, DO NOT EDIT
     2  components:
     3    headers:
     4      DeprecationHeader:
     5        description: |
     6          A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:
     7          https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html
     8        example: "2021-07-01T00:00:00Z"
     9        schema:
    10          format: date-time
    11          type: string
    12      RequestIdResponseHeader:
    13        description: |
    14          A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.
    15        example: 4b58e274-ec62-4fab-917b-1d2c48d6bdef
    16        schema:
    17          format: uuid
    18          type: string
    19      SunsetHeader:
    20        description: |
    21          A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:
    22          https://datatracker.ietf.org/doc/html/rfc8594
    23        example: "2021-08-02T00:00:00Z"
    24        schema:
    25          format: date-time
    26          type: string
    27      VersionRequestedResponseHeader:
    28        description: A header containing the version of the endpoint requested by the
    29          caller.
    30        example: "2021-06-04"
    31        schema:
    32          $ref: '#/components/schemas/QueryVersion'
    33      VersionServedResponseHeader:
    34        description: A header containing the version of the endpoint that was served
    35          by the API.
    36        example: "2021-06-04"
    37        schema:
    38          $ref: '#/components/schemas/ActualVersion'
    39      VersionStageResponseHeader:
    40        description: |
    41          A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.
    42        schema:
    43          enum:
    44          - wip
    45          - experimental
    46          - beta
    47          - ga
    48          - deprecated
    49          - sunset
    50          example: ga
    51          type: string
    52    parameters:
    53      Pagination:
    54        description: The parameters used to paginate through a list of results from
    55          the API.
    56        in: query
    57        name: page
    58        schema:
    59          additionalProperties: false
    60          properties:
    61            after:
    62              type: string
    63            before:
    64              type: string
    65            size:
    66              format: int32
    67              type: integer
    68          type: object
    69      Version:
    70        description: The requested version of the endpoint to process the request
    71        example: "2021-06-04"
    72        in: query
    73        name: version
    74        required: true
    75        schema:
    76          $ref: '#/components/schemas/QueryVersion'
    77    responses:
    78      "400":
    79        content:
    80          application/vnd.api+json:
    81            schema:
    82              $ref: '#/components/schemas/ErrorDocument'
    83        description: 'Bad Request: A parameter provided as a part of the request was
    84          invalid.'
    85        headers:
    86          deprecation:
    87            $ref: '#/components/headers/DeprecationHeader'
    88          snyk-request-id:
    89            $ref: '#/components/headers/RequestIdResponseHeader'
    90          snyk-version-lifecycle-stage:
    91            $ref: '#/components/headers/VersionStageResponseHeader'
    92          snyk-version-requested:
    93            $ref: '#/components/headers/VersionRequestedResponseHeader'
    94          snyk-version-served:
    95            $ref: '#/components/headers/VersionServedResponseHeader'
    96          sunset:
    97            $ref: '#/components/headers/SunsetHeader'
    98      "401":
    99        content:
   100          application/vnd.api+json:
   101            schema:
   102              $ref: '#/components/schemas/ErrorDocument'
   103        description: 'Unauthorized: the request requires an authentication token or
   104          a token with more permissions.'
   105        headers:
   106          deprecation:
   107            $ref: '#/components/headers/DeprecationHeader'
   108          snyk-request-id:
   109            $ref: '#/components/headers/RequestIdResponseHeader'
   110          snyk-version-lifecycle-stage:
   111            $ref: '#/components/headers/VersionStageResponseHeader'
   112          snyk-version-requested:
   113            $ref: '#/components/headers/VersionRequestedResponseHeader'
   114          snyk-version-served:
   115            $ref: '#/components/headers/VersionServedResponseHeader'
   116          sunset:
   117            $ref: '#/components/headers/SunsetHeader'
   118      "404":
   119        content:
   120          application/vnd.api+json:
   121            schema:
   122              $ref: '#/components/schemas/ErrorDocument'
   123        description: 'Not Found: The resource being operated on could not be found.'
   124        headers:
   125          deprecation:
   126            $ref: '#/components/headers/DeprecationHeader'
   127          snyk-request-id:
   128            $ref: '#/components/headers/RequestIdResponseHeader'
   129          snyk-version-lifecycle-stage:
   130            $ref: '#/components/headers/VersionStageResponseHeader'
   131          snyk-version-requested:
   132            $ref: '#/components/headers/VersionRequestedResponseHeader'
   133          snyk-version-served:
   134            $ref: '#/components/headers/VersionServedResponseHeader'
   135          sunset:
   136            $ref: '#/components/headers/SunsetHeader'
   137      "500":
   138        content:
   139          application/vnd.api+json:
   140            schema:
   141              $ref: '#/components/schemas/ErrorDocument'
   142        description: 'Internal Server Error: An error was encountered while attempting
   143          to process the request.'
   144        headers:
   145          deprecation:
   146            $ref: '#/components/headers/DeprecationHeader'
   147          snyk-request-id:
   148            $ref: '#/components/headers/RequestIdResponseHeader'
   149          snyk-version-lifecycle-stage:
   150            $ref: '#/components/headers/VersionStageResponseHeader'
   151          snyk-version-requested:
   152            $ref: '#/components/headers/VersionRequestedResponseHeader'
   153          snyk-version-served:
   154            $ref: '#/components/headers/VersionServedResponseHeader'
   155          sunset:
   156            $ref: '#/components/headers/SunsetHeader'
   157    schemas:
   158      ActualVersion:
   159        description: Resolved API version
   160        pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$
   161        type: string
   162      Error:
   163        additionalProperties: false
   164        example:
   165          detail: Not Found
   166          status: "404"
   167        properties:
   168          detail:
   169            description: A human-readable explanation specific to this occurrence of
   170              the problem.
   171            example: 'The request was missing these required fields: ...'
   172            type: string
   173          id:
   174            description: A unique identifier for this particular occurrence of the problem.
   175            example: f16c31b5-6129-4571-add8-d589da9be524
   176            format: uuid
   177            type: string
   178          meta:
   179            additionalProperties: true
   180            example:
   181              key: value
   182            type: object
   183          source:
   184            additionalProperties: false
   185            example:
   186              pointer: /data/attributes
   187            properties:
   188              parameter:
   189                description: A string indicating which URI query parameter caused the
   190                  error.
   191                example: param1
   192                type: string
   193              pointer:
   194                description: A JSON Pointer [RFC6901] to the associated entity in the
   195                  request document.
   196                example: /data/attributes
   197                type: string
   198            type: object
   199          status:
   200            description: The HTTP status code applicable to this problem, expressed
   201              as a string value.
   202            example: "400"
   203            pattern: ^[45]\d\d$
   204            type: string
   205        required:
   206        - status
   207        - detail
   208        type: object
   209      ErrorDocument:
   210        additionalProperties: false
   211        example:
   212          errors:
   213          - detail: Permission denied for this resource
   214            status: "403"
   215          jsonapi:
   216            version: "1.0"
   217        properties:
   218          errors:
   219            example:
   220            - detail: Permission denied for this resource
   221              status: "403"
   222            items:
   223              $ref: '#/components/schemas/Error'
   224            minItems: 1
   225            type: array
   226          jsonapi:
   227            $ref: '#/components/schemas/JsonApi'
   228        required:
   229        - jsonapi
   230        - errors
   231        type: object
   232      HelloWorld:
   233        additionalProperties: false
   234        properties:
   235          attributes:
   236            additionalProperties: false
   237            properties:
   238              message:
   239                type: string
   240              requestSubject:
   241                additionalProperties: false
   242                properties:
   243                  clientId:
   244                    format: uuid
   245                    type: string
   246                  publicId:
   247                    format: uuid
   248                    type: string
   249                  type:
   250                    type: string
   251                required:
   252                - publicId
   253                - type
   254                type: object
   255            required:
   256            - message
   257            - requestSubject
   258            type: object
   259          id:
   260            format: uuid
   261            type: string
   262          type:
   263            type: string
   264        required:
   265        - type
   266        - id
   267        - attributes
   268        type: object
   269      JsonApi:
   270        additionalProperties: false
   271        example:
   272          version: "1.0"
   273        properties:
   274          version:
   275            description: Version of the JSON API specification this server supports.
   276            example: "1.0"
   277            pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$
   278            type: string
   279        required:
   280        - version
   281        type: object
   282      LinkProperty:
   283        example: https://example.com/api/resource
   284        oneOf:
   285        - description: A string containing the link’s URL.
   286          example: https://example.com/api/resource
   287          type: string
   288        - additionalProperties: false
   289          example:
   290            href: https://example.com/api/resource
   291          properties:
   292            href:
   293              description: A string containing the link’s URL.
   294              example: https://example.com/api/resource
   295              type: string
   296            meta:
   297              $ref: '#/components/schemas/Meta'
   298          required:
   299          - href
   300          type: object
   301      Links:
   302        additionalProperties: false
   303        properties:
   304          first:
   305            $ref: '#/components/schemas/LinkProperty'
   306          last:
   307            $ref: '#/components/schemas/LinkProperty'
   308          next:
   309            $ref: '#/components/schemas/LinkProperty'
   310          prev:
   311            $ref: '#/components/schemas/LinkProperty'
   312          related:
   313            $ref: '#/components/schemas/LinkProperty'
   314          self:
   315            $ref: '#/components/schemas/LinkProperty'
   316        type: object
   317      Meta:
   318        additionalProperties: true
   319        description: Free-form object that may contain non-standard information.
   320        example:
   321          key1: value1
   322          key2:
   323            sub_key: sub_value
   324          key3:
   325          - array_value1
   326          - array_value2
   327        type: object
   328      QueryVersion:
   329        description: Requested API version
   330        pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
   331        type: string
   332  info:
   333    title: Registry
   334    version: 3.0.0
   335  openapi: 3.0.3
   336  paths:
   337    /examples/hello-world/{id}:
   338      get:
   339        description: Get a single result from the hello-world example
   340        operationId: helloWorldGetOne
   341        parameters:
   342        - $ref: '#/components/parameters/Version'
   343        - $ref: '#/components/parameters/Pagination'
   344        - description: The id of the hello-world example entity to be retrieved.
   345          in: path
   346          name: id
   347          required: true
   348          schema:
   349            type: string
   350        responses:
   351          "200":
   352            content:
   353              application/vnd.api+json:
   354                schema:
   355                  additionalProperties: false
   356                  properties:
   357                    data:
   358                      $ref: '#/components/schemas/HelloWorld'
   359                    jsonapi:
   360                      $ref: '#/components/schemas/JsonApi'
   361                    links:
   362                      $ref: '#/components/schemas/Links'
   363                  required:
   364                  - jsonapi
   365                  - data
   366                  - links
   367                  type: object
   368            description: A hello world entity being requested is returned
   369            headers:
   370              snyk-request-id:
   371                $ref: '#/components/headers/RequestIdResponseHeader'
   372              snyk-version-requested:
   373                $ref: '#/components/headers/VersionRequestedResponseHeader'
   374              snyk-version-served:
   375                $ref: '#/components/headers/VersionServedResponseHeader'
   376          "400":
   377            $ref: '#/components/responses/400'
   378          "401":
   379            $ref: '#/components/responses/401'
   380          "404":
   381            $ref: '#/components/responses/404'
   382          "500":
   383            $ref: '#/components/responses/500'
   384        x-snyk-api-releases:
   385        - 2021-06-01~experimental
   386        - 2021-06-07~experimental
   387        - 2021-06-13~beta
   388        x-snyk-api-version: 2021-06-01~experimental
   389        x-snyk-deprecated-by: 2021-06-07~experimental
   390        x-snyk-sunset-eligible: "2021-06-08"
   391      x-snyk-api-resource: hello-world
   392    /openapi:
   393      get:
   394        description: List available versions of OpenAPI specification
   395        operationId: listAPIVersions
   396        responses:
   397          "200":
   398            content:
   399              application/vnd.api+json:
   400                schema:
   401                  items:
   402                    type: string
   403                  type: array
   404            description: List of available versions is returned
   405            headers:
   406              snyk-request-id:
   407                $ref: '#/components/headers/RequestIdResponseHeader'
   408              snyk-version-requested:
   409                $ref: '#/components/headers/VersionRequestedResponseHeader'
   410              snyk-version-served:
   411                $ref: '#/components/headers/VersionServedResponseHeader'
   412          "400":
   413            $ref: '#/components/responses/400'
   414          "401":
   415            $ref: '#/components/responses/401'
   416          "404":
   417            $ref: '#/components/responses/404'
   418          "500":
   419            $ref: '#/components/responses/500'
   420    /openapi/{version}:
   421      get:
   422        description: Get OpenAPI specification effective at version.
   423        operationId: getAPIVersion
   424        parameters:
   425        - description: The requested version of the API
   426          in: path
   427          name: version
   428          required: true
   429          schema:
   430            type: string
   431        responses:
   432          "200":
   433            content:
   434              application/vnd.api+json:
   435                schema:
   436                  type: object
   437              application/x-yaml:
   438                schema:
   439                  type: object
   440            description: OpenAPI specification matching requested version is returned
   441            headers:
   442              snyk-request-id:
   443                $ref: '#/components/headers/RequestIdResponseHeader'
   444              snyk-version-requested:
   445                $ref: '#/components/headers/VersionRequestedResponseHeader'
   446              snyk-version-served:
   447                $ref: '#/components/headers/VersionServedResponseHeader'
   448          "400":
   449            $ref: '#/components/responses/400'
   450          "401":
   451            $ref: '#/components/responses/401'
   452          "404":
   453            $ref: '#/components/responses/404'
   454          "500":
   455            $ref: '#/components/responses/500'
   456  servers:
   457  - description: Test REST API
   458    url: https://example.com/api/rest
   459  tags:
   460  - description: Something
   461    name: Something
   462  x-snyk-api-lifecycle: sunset
   463  x-snyk-api-version: 2021-06-01~experimental