github.com/w3security/vervet/v5@v5.3.1-0.20230618081846-5bd9b5d799dc/testdata/resources/_examples/hello-world/2021-06-13/spec.yaml (about)

     1  openapi: 3.0.3
     2  x-w3security-api-stability: beta
     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:
    14      post:
    15        description: Create a single result from the hello-world example
    16        operationId: helloWorldCreate
    17        parameters:
    18          - {
    19              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/parameters/version.yaml#/Version",
    20            }
    21        requestBody:
    22          content:
    23            application/vnd.api+json:
    24              schema:
    25                type: object
    26                properties:
    27                  attributes:
    28                    type: object
    29                    properties:
    30                      message:
    31                        type: string
    32                      betaField:
    33                        type: string
    34                    additionalProperties: false
    35                    required: ["message", "betaField"]
    36                additionalProperties: false
    37                required: ["attributes"]
    38        responses:
    39          "400":
    40            {
    41              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/400.yaml#/400",
    42            }
    43          "401":
    44            {
    45              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/401.yaml#/401",
    46            }
    47          "404":
    48            {
    49              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/404.yaml#/404",
    50            }
    51          "500":
    52            {
    53              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/500.yaml#/500",
    54            }
    55          "201":
    56            description: "A hello world entity being requested is returned"
    57            x-w3security-include-headers:
    58              { $ref: "../../../schemas/headers/common-response.yaml#/Common" }
    59            headers:
    60              #w3security-version-requested: { $ref: 'https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/headers/headers.yaml#/VersionRequestedResponseHeader' }
    61              #w3security-version-served: { $ref: 'https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/headers/headers.yaml#/VersionServedResponseHeader' }
    62              #w3security-request-id: { $ref: 'https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/headers/headers.yaml#/RequestIdResponseHeader' }
    63              location:
    64                {
    65                  $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/headers/headers.yaml#/LocationHeader",
    66                }
    67            content:
    68              application/vnd.api+json:
    69                schema:
    70                  type: object
    71                  properties:
    72                    jsonapi:
    73                      {
    74                        $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/common.yaml#/JsonApi",
    75                      }
    76                    links:
    77                      {
    78                        $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/common.yaml#/Links",
    79                      }
    80                    data: { $ref: "#/components/schemas/HelloWorld" }
    81                  required: ["jsonapi", "data", "links"]
    82                  additionalProperties: false
    83  
    84    /examples/hello-world/{id}:
    85      get:
    86        description: Get a single result from the hello-world example
    87        operationId: helloWorldGetOne
    88        parameters:
    89          - {
    90              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/parameters/version.yaml#/Version",
    91            }
    92          - { $ref: "../../../schemas/parameters/pagination.yaml#/Pagination" }
    93          - name: id
    94            description: The id of the hello-world example entity to be retrieved.
    95            in: path
    96            required: true
    97            schema:
    98              type: string
    99        responses:
   100          "400":
   101            {
   102              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/400.yaml#/400",
   103            }
   104          "401":
   105            {
   106              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/401.yaml#/401",
   107            }
   108          "404":
   109            {
   110              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/404.yaml#/404",
   111            }
   112          "500":
   113            {
   114              $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/responses/500.yaml#/500",
   115            }
   116          "200":
   117            description: "A hello world entity being requested is returned"
   118            headers:
   119              w3security-version-requested:
   120                {
   121                  $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/headers/headers.yaml#/VersionRequestedResponseHeader",
   122                }
   123              w3security-version-served:
   124                {
   125                  $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/headers/headers.yaml#/VersionServedResponseHeader",
   126                }
   127              w3security-request-id:
   128                {
   129                  $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/headers/headers.yaml#/RequestIdResponseHeader",
   130                }
   131            content:
   132              application/vnd.api+json:
   133                schema:
   134                  type: object
   135                  properties:
   136                    jsonapi:
   137                      {
   138                        $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/common.yaml#/JsonApi",
   139                      }
   140                    links:
   141                      {
   142                        $ref: "https://raw.githubusercontent.com/w3security/sweater-comb/v1.2.2/components/common.yaml#/Links",
   143                      }
   144                    data: { $ref: "#/components/schemas/HelloWorld" }
   145                  required: ["jsonapi", "data", "links"]
   146                  additionalProperties: false
   147  
   148  components:
   149    schemas:
   150      HelloWorld:
   151        type: object
   152        properties:
   153          type:
   154            type: string
   155          id:
   156            type: string
   157            format: uuid
   158          attributes:
   159            type: object
   160            properties:
   161              message:
   162                type: string
   163              requestSubject:
   164                type: object
   165                properties:
   166                  publicId:
   167                    type: string
   168                    format: uuid
   169                  type:
   170                    type: string
   171                  clientId:
   172                    type: string
   173                    format: uuid
   174                required: ["publicId", "type"]
   175                additionalProperties: false
   176            required: ["message", "requestSubject"]
   177            additionalProperties: false
   178        required: ["type", "id", "attributes"]
   179        additionalProperties: false