This repository has been archived by the owner on Mar 19, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
ocds_api_specification.json
111 lines (111 loc) · 4.43 KB
/
ocds_api_specification.json
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
104
105
106
107
108
109
110
111
{
"swagger": "2.0",
"info": {
"title": "OCDS API Specification",
"version": "0.1"
},
"paths": {
"/releases.json": {
"get": {
"summary" : "Returns OCDS releases",
"description" : "This should return an object and in it should be a OCDS releases list and links object. The links object should have a 'next' property with the url of the next url that is to visited when paging through the results. Normally a full OCDS release should be in the 'releases' list. The results should be listed in modified date descending.",
"responses": {"200": {"description": "List of releases"}},
"parameters": [
{
"in": "query",
"name": "idsOnly",
"type": "string",
"description": "A list of objects is returned but contiains only the 'ocid' and 'id' properties. Useful for large datasets where you just want to see what new releases ther are."
},{
"in": "query",
"name": "page",
"type": "string",
"description": "Ask for a specific page or results if server has paging"
},{
"in": "query",
"name": "packageURL",
"type": "string",
"description": "Filter results for only releases in particular package"
},{
"in": "query",
"name": "releaseID",
"type": "string",
"description": "Filter results for only releases with this release ID"
},{
"in": "query",
"name": "ocid",
"type": "string",
"description": "Filter results for only releases with this ocid"
}
]
}
},
"/records.json": {
"get": {
"summary" : "Returns OCDS records",
"description" : "This should return an object and in it should be a OCDS records list and links object. The links object should have a 'next' property with the url of the next url that is to visited when paging through the results. Normally a full OCDS record should be in the 'records' list. The results should be listed in modified date descending.",
"responses": {"200": {"description": "List of records"}},
"parameters": [
{
"in": "query",
"name": "idsOnly",
"type": "string",
"description": "A list of objects is returned but contiains only the 'ocid' and 'id' properties. Useful for large datasets where you just want to see what new records ther are."
},{
"in": "query",
"name": "page",
"type": "string",
"description": "Ask for a specific page or results if server has paging"
},{
"in": "query",
"name": "packageURL",
"type": "string",
"description": "Filter results for only records in particular package"
}
]
}
},
"/release.json": {
"get": {
"summary" : "Returns an OCDS release",
"description" : "This should return an OCDS release package with a releases array containing a single OCDS release object. There is potential for releaseIds to be duplicated for a particular API. If this is the case then the user should provide either a packageURL or an ocid in order to get an individual release.",
"responses": {"200": {"description": "Single Release"}},
"parameters": [
{
"in": "query",
"name": "releaseID",
"required": true,
"type": "string",
"description": "The release id of the release"
},{
"in": "query",
"name": "packageURL",
"type": "string",
"description": "Specify the package of the release"
},{
"in": "query",
"name": "ocid",
"type": "string",
"description": "Specify the ocid of the release"
}
]
}
},
"/record.json": {
"get": {
"summary" : "Returns an OCDS record",
"description" : "This should return an OCDS record package with a records array containing a single OCDS record object.",
"responses": {"200": {"description": "Single Record"}},
"parameters": [
{
"in": "query",
"name": "ocid",
"required": true,
"type": "string",
"description": "The ocid of the record"
}
]
}
}
}
}