forked from alaress/schoolbox-api-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathnews@lists@folder@{id}.yaml
33 lines (33 loc) · 1.17 KB
/
news@lists@folder@{id}.yaml
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
get:
operationId: commsNews.getListForHomepage
tags: [news]
summary: Get articles audienced to the given folder
description: |
Get the list of articles audienced to the given folder.
parameters:
- $ref: ../components/parameters/id.yaml
- $ref: ../components/parameters/newsQuery/compactMode.yaml
- $ref: ../components/parameters/newsQuery/news-limit.yaml
responses:
'200':
description: |
A list of articles which are audienced to the given folder.
content:
application/json:
schema:
type: array
items:
allOf:
- $ref: ../components/schemas/news/commonFields.yaml
- type: object
properties:
body:
$ref: ../components/schemas/news/body.yaml
author:
$ref: ../components/schemas/news/author.yaml
status:
$ref: ../components/schemas/news/status.yaml
statusDate:
$ref: ../components/schemas/news/statusDate.yaml
default:
$ref: ../components/responses/problem.yaml