schoolbox-api-docs/openapi/paths/evidence@bulk@reject.yaml at develop · stevechan/schoolbox-api-docs · 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
put:
  operationId: putEvidenceBulkReject
  tags: [Learning Moment]
  summary: Reject multiple learning moments
  description: |
    Reject multiple learning moments (meaning refuse to publish them), and optionally supply a reason for the rejection.
    Note the rejection reason will appear in a comment in the discussion thread of each rejected learning moment.
  requestBody:
    content:
      application/json:
        schema:
          type: object
          properties:
            momentIds:
              type: array
              description: Array of learning moment ids.
              items:
                $ref: ../components/schemas/id.yaml
            rejectionReason:
              type: string
              description: |
                The reason for the decision not to publish the learning moment in its current state.
                Note this will appear in a comment in the discussion thread of the rejected learning moment.
              example: "Please add more detail to your descriptions."
  responses:
    '200':
      description: Successfully rejected learning moments.
      content:
        application/json:
          schema:
            type: array
            description: An array of learning moments.
            items:
              # 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: "rejected"
    default:
      $ref: ../components/responses/problem.yaml