github.com/snyk/vervet/v5@v5.11.1-0.20240202085829-ad4dd7fb6101/testdata/output/2021-06-04~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      EndingBefore:
    54        description: Return the page of results immediately before this cursor
    55        example: v1.eyJpZCI6IjExMDAifQo=
    56        in: query
    57        name: ending_before
    58        schema:
    59          type: string
    60      Limit:
    61        description: Number of results to return per page
    62        example: 10
    63        in: query
    64        name: limit
    65        schema:
    66          default: 10
    67          format: int32
    68          maximum: 100
    69          minimum: 10
    70          multipleOf: 10
    71          type: integer
    72      Pagination:
    73        description: The parameters used to paginate through a list of results from
    74          the API.
    75        in: query
    76        name: page
    77        schema:
    78          additionalProperties: false
    79          properties:
    80            after:
    81              type: string
    82            before:
    83              type: string
    84            size:
    85              format: int32
    86              type: integer
    87          type: object
    88      StartingAfter:
    89        description: Return the page of results immediately after this cursor
    90        example: v1.eyJpZCI6IjEwMDAifQo=
    91        in: query
    92        name: starting_after
    93        schema:
    94          type: string
    95      Version:
    96        description: The requested version of the endpoint to process the request
    97        example: "2021-06-04"
    98        in: query
    99        name: version
   100        required: true
   101        schema:
   102          $ref: '#/components/schemas/QueryVersion'
   103    responses:
   104      "400":
   105        content:
   106          application/vnd.api+json:
   107            schema:
   108              $ref: '#/components/schemas/ErrorDocument'
   109        description: 'Bad Request: A parameter provided as a part of the request was
   110          invalid.'
   111        headers:
   112          deprecation:
   113            $ref: '#/components/headers/DeprecationHeader'
   114          snyk-request-id:
   115            $ref: '#/components/headers/RequestIdResponseHeader'
   116          snyk-version-lifecycle-stage:
   117            $ref: '#/components/headers/VersionStageResponseHeader'
   118          snyk-version-requested:
   119            $ref: '#/components/headers/VersionRequestedResponseHeader'
   120          snyk-version-served:
   121            $ref: '#/components/headers/VersionServedResponseHeader'
   122          sunset:
   123            $ref: '#/components/headers/SunsetHeader'
   124      "401":
   125        content:
   126          application/vnd.api+json:
   127            schema:
   128              $ref: '#/components/schemas/ErrorDocument'
   129        description: 'Unauthorized: the request requires an authentication token or
   130          a token with more permissions.'
   131        headers:
   132          deprecation:
   133            $ref: '#/components/headers/DeprecationHeader'
   134          snyk-request-id:
   135            $ref: '#/components/headers/RequestIdResponseHeader'
   136          snyk-version-lifecycle-stage:
   137            $ref: '#/components/headers/VersionStageResponseHeader'
   138          snyk-version-requested:
   139            $ref: '#/components/headers/VersionRequestedResponseHeader'
   140          snyk-version-served:
   141            $ref: '#/components/headers/VersionServedResponseHeader'
   142          sunset:
   143            $ref: '#/components/headers/SunsetHeader'
   144      "404":
   145        content:
   146          application/vnd.api+json:
   147            schema:
   148              $ref: '#/components/schemas/ErrorDocument'
   149        description: 'Not Found: The resource being operated on could not be found.'
   150        headers:
   151          deprecation:
   152            $ref: '#/components/headers/DeprecationHeader'
   153          snyk-request-id:
   154            $ref: '#/components/headers/RequestIdResponseHeader'
   155          snyk-version-lifecycle-stage:
   156            $ref: '#/components/headers/VersionStageResponseHeader'
   157          snyk-version-requested:
   158            $ref: '#/components/headers/VersionRequestedResponseHeader'
   159          snyk-version-served:
   160            $ref: '#/components/headers/VersionServedResponseHeader'
   161          sunset:
   162            $ref: '#/components/headers/SunsetHeader'
   163      "500":
   164        content:
   165          application/vnd.api+json:
   166            schema:
   167              $ref: '#/components/schemas/ErrorDocument'
   168        description: 'Internal Server Error: An error was encountered while attempting
   169          to process the request.'
   170        headers:
   171          deprecation:
   172            $ref: '#/components/headers/DeprecationHeader'
   173          snyk-request-id:
   174            $ref: '#/components/headers/RequestIdResponseHeader'
   175          snyk-version-lifecycle-stage:
   176            $ref: '#/components/headers/VersionStageResponseHeader'
   177          snyk-version-requested:
   178            $ref: '#/components/headers/VersionRequestedResponseHeader'
   179          snyk-version-served:
   180            $ref: '#/components/headers/VersionServedResponseHeader'
   181          sunset:
   182            $ref: '#/components/headers/SunsetHeader'
   183    schemas:
   184      ActualVersion:
   185        description: Resolved API version
   186        pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$
   187        type: string
   188      Error:
   189        additionalProperties: false
   190        example:
   191          detail: Not Found
   192          status: "404"
   193        properties:
   194          detail:
   195            description: A human-readable explanation specific to this occurrence of
   196              the problem.
   197            example: 'The request was missing these required fields: ...'
   198            type: string
   199          id:
   200            description: A unique identifier for this particular occurrence of the problem.
   201            example: f16c31b5-6129-4571-add8-d589da9be524
   202            format: uuid
   203            type: string
   204          meta:
   205            additionalProperties: true
   206            example:
   207              key: value
   208            type: object
   209          source:
   210            additionalProperties: false
   211            example:
   212              pointer: /data/attributes
   213            properties:
   214              parameter:
   215                description: A string indicating which URI query parameter caused the
   216                  error.
   217                example: param1
   218                type: string
   219              pointer:
   220                description: A JSON Pointer [RFC6901] to the associated entity in the
   221                  request document.
   222                example: /data/attributes
   223                type: string
   224            type: object
   225          status:
   226            description: The HTTP status code applicable to this problem, expressed
   227              as a string value.
   228            example: "400"
   229            pattern: ^[45]\d\d$
   230            type: string
   231        required:
   232        - status
   233        - detail
   234        type: object
   235      ErrorDocument:
   236        additionalProperties: false
   237        example:
   238          errors:
   239          - detail: Permission denied for this resource
   240            status: "403"
   241          jsonapi:
   242            version: "1.0"
   243        properties:
   244          errors:
   245            example:
   246            - detail: Permission denied for this resource
   247              status: "403"
   248            items:
   249              $ref: '#/components/schemas/Error'
   250            minItems: 1
   251            type: array
   252          jsonapi:
   253            $ref: '#/components/schemas/JsonApi'
   254        required:
   255        - jsonapi
   256        - errors
   257        type: object
   258      HelloWorld:
   259        additionalProperties: false
   260        properties:
   261          attributes:
   262            additionalProperties: false
   263            properties:
   264              message:
   265                type: string
   266              requestSubject:
   267                additionalProperties: false
   268                properties:
   269                  clientId:
   270                    format: uuid
   271                    type: string
   272                  publicId:
   273                    format: uuid
   274                    type: string
   275                  type:
   276                    type: string
   277                required:
   278                - publicId
   279                - type
   280                type: object
   281            required:
   282            - message
   283            - requestSubject
   284            type: object
   285          id:
   286            format: uuid
   287            type: string
   288          type:
   289            type: string
   290        required:
   291        - type
   292        - id
   293        - attributes
   294        type: object
   295      JsonApi:
   296        additionalProperties: false
   297        example:
   298          version: "1.0"
   299        properties:
   300          version:
   301            description: Version of the JSON API specification this server supports.
   302            example: "1.0"
   303            pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$
   304            type: string
   305        required:
   306        - version
   307        type: object
   308      LinkProperty:
   309        example: https://example.com/api/resource
   310        oneOf:
   311        - description: A string containing the link’s URL.
   312          example: https://example.com/api/resource
   313          type: string
   314        - additionalProperties: false
   315          example:
   316            href: https://example.com/api/resource
   317          properties:
   318            href:
   319              description: A string containing the link’s URL.
   320              example: https://example.com/api/resource
   321              type: string
   322            meta:
   323              $ref: '#/components/schemas/Meta'
   324          required:
   325          - href
   326          type: object
   327      Links:
   328        additionalProperties: false
   329        properties:
   330          first:
   331            $ref: '#/components/schemas/LinkProperty'
   332          last:
   333            $ref: '#/components/schemas/LinkProperty'
   334          next:
   335            $ref: '#/components/schemas/LinkProperty'
   336          prev:
   337            $ref: '#/components/schemas/LinkProperty'
   338          related:
   339            $ref: '#/components/schemas/LinkProperty'
   340          self:
   341            $ref: '#/components/schemas/LinkProperty'
   342        type: object
   343      Meta:
   344        additionalProperties: true
   345        description: Free-form object that may contain non-standard information.
   346        example:
   347          key1: value1
   348          key2:
   349            sub_key: sub_value
   350          key3:
   351          - array_value1
   352          - array_value2
   353        type: object
   354      Project:
   355        additionalProperties: false
   356        properties:
   357          attributes:
   358            additionalProperties: false
   359            properties:
   360              created:
   361                description: The date that the project was created on
   362                example: "2021-05-29T09:50:54.014Z"
   363                type: string
   364              hostname:
   365                description: The hostname for a CLI project, null if not set
   366                nullable: true
   367                type: string
   368              name:
   369                type: string
   370              origin:
   371                description: The origin the project was added from
   372                example: github
   373                type: string
   374              status:
   375                description: Describes if a project is currently monitored or it is
   376                  de-activated
   377                example: active
   378                type: string
   379              type:
   380                description: The package manager of the project
   381                example: maven
   382                type: string
   383            required:
   384            - name
   385            - created
   386            - origin
   387            - type
   388            - status
   389            type: object
   390          id:
   391            description: The ID.
   392            example: 331ede0a-de94-456f-b788-166caeca58bf
   393            type: string
   394          type:
   395            description: Content type.
   396            example: projects
   397            type: string
   398        required:
   399        - type
   400        - id
   401        - attributes
   402        type: object
   403      QueryVersion:
   404        description: Requested API version
   405        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))?))$
   406        type: string
   407  info:
   408    title: Registry
   409    version: 3.0.0
   410  openapi: 3.0.3
   411  paths:
   412    /examples/hello-world/{id}:
   413      get:
   414        description: Get a single result from the hello-world example
   415        operationId: helloWorldGetOne
   416        parameters:
   417        - $ref: '#/components/parameters/Version'
   418        - $ref: '#/components/parameters/Pagination'
   419        - description: The id of the hello-world example entity to be retrieved.
   420          in: path
   421          name: id
   422          required: true
   423          schema:
   424            type: string
   425        responses:
   426          "200":
   427            content:
   428              application/vnd.api+json:
   429                schema:
   430                  additionalProperties: false
   431                  properties:
   432                    data:
   433                      $ref: '#/components/schemas/HelloWorld'
   434                    jsonapi:
   435                      $ref: '#/components/schemas/JsonApi'
   436                    links:
   437                      $ref: '#/components/schemas/Links'
   438                  required:
   439                  - jsonapi
   440                  - data
   441                  - links
   442                  type: object
   443            description: A hello world entity being requested is returned
   444            headers:
   445              snyk-request-id:
   446                $ref: '#/components/headers/RequestIdResponseHeader'
   447              snyk-version-requested:
   448                $ref: '#/components/headers/VersionRequestedResponseHeader'
   449              snyk-version-served:
   450                $ref: '#/components/headers/VersionServedResponseHeader'
   451          "400":
   452            $ref: '#/components/responses/400'
   453          "401":
   454            $ref: '#/components/responses/401'
   455          "404":
   456            $ref: '#/components/responses/404'
   457          "500":
   458            $ref: '#/components/responses/500'
   459        x-snyk-api-releases:
   460        - 2021-06-01~experimental
   461        - 2021-06-07~experimental
   462        - 2021-06-13~beta
   463        x-snyk-api-version: 2021-06-01~experimental
   464        x-snyk-deprecated-by: 2021-06-07~experimental
   465        x-snyk-sunset-eligible: "2021-06-08"
   466      x-snyk-api-resource: hello-world
   467    /openapi:
   468      get:
   469        description: List available versions of OpenAPI specification
   470        operationId: listAPIVersions
   471        responses:
   472          "200":
   473            content:
   474              application/vnd.api+json:
   475                schema:
   476                  items:
   477                    type: string
   478                  type: array
   479            description: List of available versions is returned
   480            headers:
   481              snyk-request-id:
   482                $ref: '#/components/headers/RequestIdResponseHeader'
   483              snyk-version-requested:
   484                $ref: '#/components/headers/VersionRequestedResponseHeader'
   485              snyk-version-served:
   486                $ref: '#/components/headers/VersionServedResponseHeader'
   487          "400":
   488            $ref: '#/components/responses/400'
   489          "401":
   490            $ref: '#/components/responses/401'
   491          "404":
   492            $ref: '#/components/responses/404'
   493          "500":
   494            $ref: '#/components/responses/500'
   495    /openapi/{version}:
   496      get:
   497        description: Get OpenAPI specification effective at version.
   498        operationId: getAPIVersion
   499        parameters:
   500        - description: The requested version of the API
   501          in: path
   502          name: version
   503          required: true
   504          schema:
   505            type: string
   506        responses:
   507          "200":
   508            content:
   509              application/vnd.api+json:
   510                schema:
   511                  type: object
   512              application/x-yaml:
   513                schema:
   514                  type: object
   515            description: OpenAPI specification matching requested version is returned
   516            headers:
   517              snyk-request-id:
   518                $ref: '#/components/headers/RequestIdResponseHeader'
   519              snyk-version-requested:
   520                $ref: '#/components/headers/VersionRequestedResponseHeader'
   521              snyk-version-served:
   522                $ref: '#/components/headers/VersionServedResponseHeader'
   523          "400":
   524            $ref: '#/components/responses/400'
   525          "401":
   526            $ref: '#/components/responses/401'
   527          "404":
   528            $ref: '#/components/responses/404'
   529          "500":
   530            $ref: '#/components/responses/500'
   531    /orgs/{orgId}/projects:
   532      get:
   533        description: Get a list of an organization's projects.
   534        operationId: getOrgsProjects
   535        parameters:
   536        - $ref: '#/components/parameters/Version'
   537        - $ref: '#/components/parameters/StartingAfter'
   538        - $ref: '#/components/parameters/EndingBefore'
   539        - $ref: '#/components/parameters/Limit'
   540        - description: The id of the org to return a list of projects
   541          in: path
   542          name: orgId
   543          required: true
   544          schema:
   545            type: string
   546        - description: The options for filtering the result set
   547          in: query
   548          name: filters
   549          schema:
   550            additionalProperties: false
   551            properties:
   552              attributes.criticality:
   553                items:
   554                  type: string
   555                type: array
   556              attributes.environment:
   557                items:
   558                  type: string
   559                type: array
   560              attributes.lifecycle:
   561                items:
   562                  type: string
   563                type: array
   564              name:
   565                type: string
   566              origin:
   567                type: string
   568              status:
   569                enum:
   570                - active
   571                - inactive
   572                type: string
   573              tags.includes:
   574                items:
   575                  type: string
   576                type: array
   577              type:
   578                type: string
   579            type: object
   580        responses:
   581          "200":
   582            content:
   583              application/vnd.api+json:
   584                schema:
   585                  additionalProperties: false
   586                  properties:
   587                    data:
   588                      items:
   589                        $ref: '#/components/schemas/Project'
   590                      type: array
   591                    jsonapi:
   592                      $ref: '#/components/schemas/JsonApi'
   593                    links:
   594                      $ref: '#/components/schemas/Links'
   595                  required:
   596                  - jsonapi
   597                  - data
   598                  - links
   599                  type: object
   600            description: A list of projects is returned for the targeted org
   601            headers:
   602              snyk-request-id:
   603                $ref: '#/components/headers/RequestIdResponseHeader'
   604              snyk-version-requested:
   605                $ref: '#/components/headers/VersionRequestedResponseHeader'
   606              snyk-version-served:
   607                $ref: '#/components/headers/VersionServedResponseHeader'
   608          "400":
   609            $ref: '#/components/responses/400'
   610          "401":
   611            $ref: '#/components/responses/401'
   612          "404":
   613            $ref: '#/components/responses/404'
   614          "500":
   615            $ref: '#/components/responses/500'
   616        tags:
   617        - Projects
   618        x-snyk-api-releases:
   619        - 2021-06-04~experimental
   620        x-snyk-api-version: 2021-06-04~experimental
   621      x-snyk-api-resource: projects
   622  servers:
   623  - description: Test REST API
   624    url: https://example.com/api/rest
   625  tags:
   626  - description: Projects
   627    name: Projects
   628  - description: Something
   629    name: Something
   630  x-snyk-api-lifecycle: sunset
   631  x-snyk-api-version: 2021-06-04~experimental