github.com/w3security/vervet/v5@v5.3.1-0.20230618081846-5bd9b5d799dc/testdata/resources/projects/2021-06-04/spec.yaml (about)

     1  openapi: 3.0.3
     2  x-w3security-api-stability: experimental
     3  info:
     4    title: Registry
     5    version: 3.0.0
     6  servers:
     7    - url: /api/v3
     8      description: W3Security Registry
     9  components:
    10    x-somewhere-else:
    11      $ref: "https://raw.githubusercontent.com/w3security/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          - {
    23              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/parameters/version.yaml#/Version",
    24            }
    25          - {
    26              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/parameters/pagination.yaml#/parameters/StartingAfter",
    27            }
    28          - {
    29              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/parameters/pagination.yaml#/parameters/EndingBefore",
    30            }
    31          - {
    32              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/parameters/pagination.yaml#/parameters/Limit",
    33            }
    34          - name: orgId
    35            in: path
    36            required: true
    37            description: The id of the org to return a list of projects
    38            schema:
    39              type: string
    40          - in: query
    41            description: The options for filtering the result set
    42            name: filters
    43            schema:
    44              type: object
    45              additionalProperties: false
    46              properties:
    47                name:
    48                  type: string
    49                origin:
    50                  type: string
    51                type:
    52                  type: string
    53                status:
    54                  type: string
    55                  enum:
    56                    - active
    57                    - inactive
    58                "tags.includes":
    59                  type: array
    60                  items:
    61                    type: string
    62                "attributes.criticality":
    63                  type: array
    64                  items:
    65                    type: string
    66                "attributes.environment":
    67                  type: array
    68                  items:
    69                    type: string
    70                "attributes.lifecycle":
    71                  type: array
    72                  items:
    73                    type: string
    74        responses:
    75          "400":
    76            {
    77              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/400.yaml#/400",
    78            }
    79          "401":
    80            {
    81              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/401.yaml#/401",
    82            }
    83          "404":
    84            {
    85              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/404.yaml#/404",
    86            }
    87          "500":
    88            {
    89              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/500.yaml#/500",
    90            }
    91          "200":
    92            description: "A list of projects is returned for the targeted org"
    93            headers:
    94              w3security-version-requested:
    95                {
    96                  $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/headers/headers.yaml#/VersionRequestedResponseHeader",
    97                }
    98              w3security-version-served:
    99                {
   100                  $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/headers/headers.yaml#/VersionServedResponseHeader",
   101                }
   102              w3security-request-id:
   103                {
   104                  $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/headers/headers.yaml#/RequestIdResponseHeader",
   105                }
   106            content:
   107              application/vnd.api+json:
   108                schema:
   109                  type: object
   110                  properties:
   111                    jsonapi:
   112                      {
   113                        $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/common.yaml#/JsonApi",
   114                      }
   115                    data:
   116                      type: array
   117                      items:
   118                        { $ref: "../../schemas/models/project.yaml#/Project" }
   119                    links:
   120                      {
   121                        $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/common.yaml#/Links",
   122                      }
   123                  required: ["jsonapi", "data", "links"]
   124                  additionalProperties: false