This commit is contained in:
Thomas Rooney
2023-07-17 14:58:44 +01:00
committed by quobix
parent c9cf000f4c
commit 1d6048dd42
2 changed files with 20 additions and 50 deletions

View File

@@ -3,18 +3,7 @@ info:
title: Example
version: 0.0.1
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
Error:
type: object
properties:
message:
type: string
description: Error message
Example:
type: object
required:
@@ -29,15 +18,12 @@ components:
type: string
title: Description
description: Brief description of this Example. Optional.
security:
- bearerAuth: []
paths:
/system/examples/{id}:
get:
tags:
&a1
- Examples
summary: Get a list of Example objects
parameters:
&id
- name: id
@@ -45,41 +31,18 @@ paths:
required: true
schema:
type: string
description: Unique ID
description: Get a list of Example objects
responses:
&a2
"200":
description: a list of Example objects
content:
&example
application/json:
schema:
type: object
properties:
count:
type: integer
description: number of items present in the items array
items:
type: array
items:
$ref: "#/components/schemas/Example"
"401":
description: Unauthorized
"500":
description: Unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
$ref: '#/components/schemas/Example'
post:
tags: *a1
parameters: *id
summary: Create Example
description: Create Example
responses: *a2
requestBody:
description: New Example object
content:
application/json:
schema:
$ref: "#/components/schemas/Example"
responses: *a2
content: *example