forked from alaress/schoolbox-api-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathevidence@{id}@draft.yaml
More file actions
34 lines (34 loc) · 1.11 KB
/
Copy pathevidence@{id}@draft.yaml
File metadata and controls
34 lines (34 loc) · 1.11 KB
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
put:
operationId: putEvidenceDraft
tags: [Learning Moment]
summary: Draft a learning moment
description: Update a learning moment and leave it in a 'draft' state.
requestBody:
description: |
The learning moment to save. Only fields to be updated need to be included in the request.
content:
application/json:
schema:
$ref: ../components/schemas/learning-moment-request.yaml
responses:
'200':
description: Successfully drafted a learning moment.
content:
application/json:
schema:
# Use the learning-moment-response schema, but override the example value for currentState.
allOf:
- $ref: ../components/schemas/learning-moment-response.yaml
- type: object
properties:
currentState:
example: "draft"
default:
$ref: ../components/responses/problem.yaml
parameters:
- name: id
in: path
description: The ID of the learning moment you wish to put into a 'draft' state.
required: true
schema:
type: integer