github.com/w3security/vervet/v5@v5.3.1-0.20230618081846-5bd9b5d799dc/testdata/resources/_examples/hello-world/2021-06-01/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  tags:
    10    - name: Something
    11      description: Something
    12  paths:
    13    /examples/hello-world/{id}:
    14      get:
    15        description: Get a single result from the hello-world example
    16        operationId: helloWorldGetOne
    17        parameters:
    18          - {
    19              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/parameters/version.yaml#/Version",
    20            }
    21          - { $ref: "../../../schemas/parameters/pagination.yaml#/Pagination" }
    22          - name: id
    23            description: The id of the hello-world example entity to be retrieved.
    24            in: path
    25            required: true
    26            schema:
    27              type: string
    28        responses:
    29          "400":
    30            {
    31              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/400.yaml#/400",
    32            }
    33          "401":
    34            {
    35              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/401.yaml#/401",
    36            }
    37          "404":
    38            {
    39              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/404.yaml#/404",
    40            }
    41          "500":
    42            {
    43              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/500.yaml#/500",
    44            }
    45          "200":
    46            description: "A hello world entity being requested is returned"
    47            headers:
    48              w3security-version-requested:
    49                {
    50                  $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/headers/headers.yaml#/VersionRequestedResponseHeader",
    51                }
    52              w3security-version-served:
    53                {
    54                  $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/headers/headers.yaml#/VersionServedResponseHeader",
    55                }
    56              w3security-request-id:
    57                {
    58                  $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/headers/headers.yaml#/RequestIdResponseHeader",
    59                }
    60            content:
    61              application/vnd.api+json:
    62                schema:
    63                  type: object
    64                  properties:
    65                    jsonapi:
    66                      {
    67                        $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/common.yaml#/JsonApi",
    68                      }
    69                    links:
    70                      {
    71                        $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/common.yaml#/Links",
    72                      }
    73                    data: { $ref: "#/components/schemas/HelloWorld" }
    74                  required: ["jsonapi", "data", "links"]
    75                  additionalProperties: false
    76  
    77  components:
    78    schemas:
    79      HelloWorld:
    80        type: object
    81        properties:
    82          type:
    83            type: string
    84          id:
    85            type: string
    86            format: uuid
    87          attributes:
    88            type: object
    89            properties:
    90              message:
    91                type: string
    92              requestSubject:
    93                type: object
    94                properties:
    95                  publicId:
    96                    type: string
    97                    format: uuid
    98                  type:
    99                    type: string
   100                  clientId:
   101                    type: string
   102                    format: uuid
   103                required: ["publicId", "type"]
   104                additionalProperties: false
   105            required: ["message", "requestSubject"]
   106            additionalProperties: false
   107        required: ["type", "id", "attributes"]
   108        additionalProperties: false