github.com/snyk/vervet/v5@v5.11.1-0.20240202085829-ad4dd7fb6101/testdata/conflict-components/projects/2021-06-04/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  components:
    10    x-somewhere-else:
    11      $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.6.0/components/common.yaml'
    12    parameters:
    13      Version:
    14        name: version
    15        in: query
    16        required: true
    17        description: The requested version of the endpoint to process the request
    18        schema:
    19          type: number
    20      Conflict:
    21        name: conflict
    22        in: query
    23        required: true
    24        description: Different conflict description
    25        schema:
    26          type: string
    27    schemas:
    28      JsonApi:
    29        type: object
    30        properties:
    31          version:
    32            type: string
    33            enum: ["1.0"]
    34        required: [ 'version' ]
    35        additionalProperties: false
    36        example:
    37          version: "1.0"
    38  paths:
    39    /orgs/{orgId}/projects:
    40      get:
    41        description: Get a list of an organization's projects.
    42        operationId: getOrgsProjects
    43        parameters:
    44          - { $ref: '#/components/parameters/Version' }
    45          - { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/parameters/pagination.yaml#/parameters/StartingAfter' }
    46          - { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/parameters/pagination.yaml#/parameters/EndingBefore' }
    47          - { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/parameters/pagination.yaml#/parameters/Limit' }
    48          - name: orgId
    49            in: path
    50            required: true
    51            description: The id of the org to return a list of projects
    52            schema:
    53              type: string
    54          - in: query
    55            description: The options for filtering the result set
    56            name: filters
    57            schema:
    58              type: object
    59              additionalProperties: false
    60              properties:
    61                name:
    62                  type: string
    63                origin:
    64                  type: string
    65                type:
    66                  type: string
    67                status:
    68                  type: string
    69                  enum:
    70                    - active
    71                    - inactive
    72                'tags.includes':
    73                  type: array
    74                  items:
    75                    type: string
    76                'attributes.criticality':
    77                  type: array
    78                  items:
    79                    type: string
    80                'attributes.environment':
    81                  type: array
    82                  items:
    83                    type: string
    84                'attributes.lifecycle':
    85                  type: array
    86                  items:
    87                    type: string
    88          - $ref: '#/components/parameters/Conflict'
    89        responses:
    90          '400': { $ref: '../../../resources/schemas/responses/400.yaml#/400' }
    91          '401': { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/responses/401.yaml#/401' }
    92          '404': { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/responses/404.yaml#/404' }
    93          '500': { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/responses/500.yaml#/500' }
    94          '200':
    95            description: 'A list of projects is returned for the targeted org'
    96            headers:
    97              snyk-version-requested: { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/headers/headers.yaml#/VersionRequestedResponseHeader' }
    98              snyk-version-served: { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/headers/headers.yaml#/VersionServedResponseHeader' }
    99              snyk-request-id: { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/headers/headers.yaml#/RequestIdResponseHeader' }
   100            content:
   101              application/vnd.api+json:
   102                schema:
   103                  type: object
   104                  properties:
   105                    jsonapi: { $ref: '#/components/schemas/JsonApi' }
   106                    data:
   107                      type: array
   108                      items: { $ref: '../../../resources/schemas/models/project.yaml#/Project' }
   109                    links: { $ref: 'https://raw.githubusercontent.com/snyk/sweater-comb/v1.2.2/components/common.yaml#/Links' }
   110                  required: ['jsonapi', 'data', 'links' ]
   111                  additionalProperties: false