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