onasty: api/paths/note/note-slug.yml (c0b5079c234cf570a675ada6bdd08b690e4e91c7)

onasty/api/paths/note/note-slug.yml (view raw)

Oleksandr Smirnov api: add openapi docs (#181)..., 9 months ago

get:
  tags: [Notes]
  summary: Read note
  security:
    - {}

  parameters:
    - name: slug
      in: path
      required: true
      schema:
        type: string

  responses:
    '200':
      $ref: '../../components/responses/NoteGet.yml'
    '404':
      $ref: '../../components/responses/NoteNotFoundMaybeWithContent.yml'


delete:
  tags: [Notes]
  summary: Delete a note
  security:
    - Bearer: []

  parameters:
    - name: slug
      in: path
      required: true
      schema:
        type: string

  responses:
    '204':
      description: Note deleted
    '401':
      description: Unauthorized
    '404':
      $ref: '../../components/responses/NoteNotFound.yml'

1	get:
2	tags: [Notes]
3	summary: Read note
4	security:
5	- {}
6
7	parameters:
8	- name: slug
9	in: path
10	required: true
11	schema:
12	type: string
13
14	responses:
15	'200':
16	$ref: '../../components/responses/NoteGet.yml'
17	'404':
18	$ref: '../../components/responses/NoteNotFoundMaybeWithContent.yml'
19
20
21	delete:
22	tags: [Notes]
23	summary: Delete a note
24	security:
25	- Bearer: []
26
27	parameters:
28	- name: slug
29	in: path
30	required: true
31	schema:
32	type: string
33
34	responses:
35	'204':
36	description: Note deleted
37	'401':
38	description: Unauthorized
39	'404':
40	$ref: '../../components/responses/NoteNotFound.yml'