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