onasty: api/paths/note/note-slug-password.yml (3f331186ab8a30c68264a0e1aa9ff78377420e00)

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

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

patch:
  tags: [Notes]
  summary: Change note's password
  security:
    - Bearer: []

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

  requestBody:
    required: true
    content:
      application/json:
        schema:
          type: object
          properties:
            password:
              type: string
              example: newPassword

  responses:
    '200':
      description: Note updated
    '400':
      $ref: '../../components/responses/ErrorResponse.yml'
    '401':
      description: Unauthorized
    '404':
      $ref: '../../components/responses/NoteNotFound.yml'

1	patch:
2	tags: [Notes]
3	summary: Change note's password
4	security:
5	- Bearer: []
6
7	parameters:
8	- name: slug
9	in: path
10	required: true
11	schema:
12	type: string
13
14	requestBody:
15	required: true
16	content:
17	application/json:
18	schema:
19	type: object
20	properties:
21	password:
22	type: string
23	example: newPassword
24
25	responses:
26	'200':
27	description: Note updated
28	'400':
29	$ref: '../../components/responses/ErrorResponse.yml'
30	'401':
31	description: Unauthorized
32	'404':
33	$ref: '../../components/responses/NoteNotFound.yml'