rustapi/openapi.yaml at master · ndelvalle/rustapi · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
openapi: 3.1.0

info:
  version: 1.0.0
  title: v1 REST API
  description: v1 REST API

servers:
- url: https://api.yoururl.com

externalDocs:
  description: v1 REST API
  url: https://github.com/ndelvalle/rustapi

paths:
  "/v1/cats":
    # Query cats
    get:
      summary: Query cats
      description: Query cats
      operationId: application/query-cats
      security:
        - bearerAuth: []
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/Cat"
        '401':
          $ref: '#/components/responses/Unauthorized'

    # Create a new cat
    post:
      summary: Create a new cat
      description: Create a new cat
      operationId: application/create-cat
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                  description: The cat name
      responses:
        '201':
          description: Response
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/Cat"
        '401':
          $ref: '#/components/responses/Unauthorized'

  "/v1/cats/{cat_id}":
    # Get cat by ID
    get:
      summary: Get cat by ID
      description: get cat by ID
      operationId: application/get-cat-by-id
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/Cat"
        '401':
          $ref: '#/components/responses/Unauthorized'

    # Remove cat by ID
    delete:
      summary: Remove a cat by ID
      description: Removes a cat by ID
      operationId: application/remove-cat-by-id
      responses:
        '204':
          description: Response
        '401':
          $ref: '#/components/responses/Unauthorized'

    # Update cat by ID
    patch:
      summary: Update a cat by ID
      description: Update cat by ID
      operationId: application/update-cat-by-id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                  description: The cat name
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/Cat"
        '401':
          $ref: '#/components/responses/Unauthorized'

components:
  schemas:
    # Cat schema
    Cat:
      type: object
      required:
        - id
        - user
        - name
        - created_at
        - updated_at
      properties:
        id:
          type: string
        user:
          type: string
        name:
          type: string
        created_at:
          type: string
        updated_at:
          type: string

  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

  responses:
    Unauthorized:
      description: Authentication information is missing or invalid