-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
103 lines (103 loc) · 2.39 KB
/
openapi.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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
swagger: "2.0"
info:
description: Labic API to access data
title: Hash Data Driven API
version: "0.0.1"
host: localhost:5000
basePath: /
consumes:
- application/json
produces:
- application/json
schemes:
- http
paths:
/articles:
get:
description: Get Articles
operationId: findArticles
parameters:
- name: filters[dateCreated]
in: query
description: Filter by a time interval using the standard [ISO 860 - Time Intervals](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)
required: false
type: string
format: date-time/date-time
- name: filters[datePublished]
in: query
description: Filter by a time interval using the standard [ISO 860 - Time Intervals](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)
required: false
type: string
- name: filters[keywords]
in: query
description: Filter by a list of keyworkds
required: false
type: array
collectionFormat: csv
items:
type: string
- name: fields
in: query
description: Return only the fields listed
required: false
type: array
collectionFormat: csv
items:
type: string
- name: page
in: query
description: Pagination control
required: false
type: integer
format: int32
- name: per_page
in: query
description: Articles per page
required: false
type: integer
format: int32
responses:
200:
description: "successful operation"
schema:
type: "array"
items:
$ref: "#/definitions/Article"
definitions:
Article:
properties:
id:
type: string
type:
type: string
name:
type: string
keywords:
type: array
format: string
articleBody:
type: string
dateCreated:
type: string
format: date-time
dateModified:
type: string
format: date-time
datePublished:
type: string
format: date-time
Author:
properties:
type:
type: string
name:
type: string
Error:
properties:
code:
type: integer
format: int32
message:
type: string
fields:
type: string