openapi/openapi.yaml at main · kha7an/openapi · 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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
openapi: 3.0.3
info:
  title: API сервиса для тестового задания
  version: 0.1.0
tags:
  - name: students
    description: Всё что касается учеников
  - name: classes
    description: Всё что касается классов
paths:
  /students:
    post:
      tags:
        - students
      summary: Регистрация нового студента
      operationId: createStudent
      requestBody:
        description: Новый студент
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Student'
        required: true
      responses:
        '201':
          description: Successful operation
          headers:
            X-Auth-Token:
              description: Токен для последующей авторизации, например sha256(user_id + secret_salt)
              example: 3525dcdddea774939652f7f11df6d7db10a9db35a5d758c64d600a00c1cc41be
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Student'
        default:
        '405':
          description: Invalid input
  /students/{user_id}:
    parameters:
      - name: user_id
        description: id студента
        in: path
        required: true
        schema:
          type: integer
          format: int64
    delete:
      tags:
        - students
      summary: Удалить студента
      operationId: deleteStudent
      security:
        - bearerAuth: []
      responses:
        '400':
          description: Некорректный id студента
        '401':
          description: Некорректная авторизация

  /schools/{school_id}/classes/{class_id}/students:
    parameters:
      - $ref: '#/components/parameters/school_id'
      - $ref: '#/components/parameters/class_id'
    get:
      tags:
        - students
        - classes
      summary: Вывести список студентов класса
      operationId: getClassStudentList
      responses:
        '200':
          description: Список студентов
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Student'


  /schools/{school_id}/classes:
    parameters:
      - $ref: '#/components/parameters/school_id'
    get:
      tags:
        - classes
      summary: Вывести список классов школы
      operationId: getClassList
      responses:
        '200':
          description: Список классов
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Class'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Ожидается токен, выдаваемый при регистрации студента
      bearerFormat: SHA256
  parameters:
    school_id:
      name: school_id
      in: path
      required: true
      schema:
        type: integer
        format: int32
    class_id:
      name: class_id
      description: id класса
      in: path
      required: true
      schema:
        type: integer
        format: int32
  schemas:
    Class:
      type: object
      required:
        - id
        - number
        - letter
        - students_count
      properties:
        id:
          type: integer
          format: int32
          example: 10
          readOnly: true
        number:
          type: integer
          format: int32
          example: 1
          description: Цифра класса
        letter:
          type: string
          example: Б
          description: Буква класса
        students_count:
          type: integer
          format: int32
          example: 32
          readOnly: true
          description: Количество учеников в классе
    Student:
      required:
        - id
        - first_name
        - last_name
        - surname
        - class_id
        - school_id
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 10
          readOnly: true
        first_name:
          type: string
          example: Вячеслав
        last_name:
          type: string
          example: Абдурахмангаджиевич
        surname:
          type: string
          example: Мухобойников-Сыркин
        class_id:
          type: integer
          format: int32
        school_id:
          type: integer
          format: int32