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