schoolbox-api-docs/openapi/paths/news@lists@feed.yaml at develop · alaress/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
43
44
45
46
47
48
49
50
51
52
53
get:
  operationId: commsNews.getListForIndex
  tags: [news]
  summary: Get articles audienced to the authenticated user
  description: |
    Get the list of articles audienced to the currently authenticated user.
  parameters:
    - $ref: ../components/parameters/newsQuery/topic.yaml
  responses:
    '200':
      description: |
        A list of articles which are audienced to the authenticated user.
      content:
        application/json:
          schema:
            type: array
            items:
              allOf:
                - $ref: ../components/schemas/news/commonFields.yaml
                - type: object
                  properties:
                    status:
                      $ref: ../components/schemas/news/status.yaml
                    statusDate:
                      $ref: ../components/schemas/news/statusDate.yaml
                    readMore:
                      $ref: ../components/schemas/news/readMore.yaml
                    metadata:
                      type: object
                      properties:
                        commentCount:
                          type: integer
                          description: |
                            The number of comments on this article.

                            May be null, in which case there are no comments.
                    attachments:
                      type: integer
                      description: |
                        The number of attachments on this article.

                        May be null, in which case there are no attachments.
                    viewedAt:
                      allOf:
                        - description: |
                            The datetime the news article was originally read by the user.

                            May be null, in which case the user has not read the article
                        - $ref: ../components/schemas/dateTimeString.yaml
                    _links:
                      $ref: ../components/schemas/news/links.yaml
    default:
      $ref: ../components/responses/problem.yaml