Skip to content

Commit 5896d39

Browse files
dfcoffindfcoffin
authored
Merge pull request #46 from GreenButtonAlliance/OpenAPI-3.0-Upgrade
Open api 3.0 upgrade
2 parents de1f852 + 09a00c7 commit 5896d39

14 files changed

Lines changed: 431 additions & 2151 deletions

‎API/api-docs‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"path": "/../listings/ElectricPowerQualitySummary"
1717
},
1818
{
19-
"path": "/../listings/ElectricPowerUsageSummary"
19+
"path": "/../listings/UsageSummary"
2020
},
2121
{
2222
"path": "/../listings/IntervalBlock"
@@ -35,9 +35,6 @@
3535
},
3636
{
3737
"path": "/../listings/UsagePoint"
38-
},
39-
{
40-
"path": "/../listings/SandboxDataBaseManagement"
4138
}
4239
]
4340
}

‎API/listings/ApplicationInformation‎

Lines changed: 1 addition & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -97,41 +97,7 @@
9797
"message": "Forbidden"
9898
}
9999
]
100-
},
101-
{
102-
"method": "POST",
103-
"summary": "Add a new Application Information Structure [FB_33]",
104-
"notes": "To provide the required Bearer access token in the HTTP Authorization header, enter the <strong>\"data_custodian_access_token\"</strong> in the appropriate field at the top of this web page!",
105-
"nickname": "addApplicationInformation",
106-
"consumes": ["application/atom+xml"],
107-
"authorizations": ["oauth2"],
108-
"parameters":
109-
[
110-
{
111-
"name": "applicationInformationData",
112-
"description": "The new Application Information data.",
113-
"required": true,
114-
"allowMultiple": true,
115-
"dataType": "String",
116-
"paramType": "body"
117-
}
118-
],
119-
"responseMessages":
120-
[
121-
{
122-
"code": 201,
123-
"message": "Created"
124-
},
125-
{
126-
"code": 400,
127-
"message": "Bad Request"
128-
},
129-
{
130-
"code": 403,
131-
"message": "Forbidden"
132-
}
133-
]
134-
}
100+
}
135101
]
136102
},
137103
{
@@ -174,93 +140,6 @@
174140
"message": "Forbidden"
175141
}
176142
]
177-
},
178-
{
179-
"method": "PUT",
180-
"summary": "Update an existing Application Information Structure [FB_41]",
181-
"notes": "The Application Information must exist. To provide the required Bearer access token in the HTTP Authorization header, enter the <strong>\"data_custodian_access_token\"</strong> or <strong>\"registration_access_token\"</strong> in the appropriate field at the top of this web page!",
182-
"nickname": "updateApplicationInformation",
183-
"consumes": ["application/atom+xml"],
184-
"authorizations": ["oauth2"],
185-
"parameters":
186-
[
187-
{
188-
"name": "applicationInformationId",
189-
"description": "The Id of the Application Information.",
190-
"required": true,
191-
"allowMultiple": true,
192-
"dataType": "String",
193-
"paramType": "path"
194-
},
195-
{
196-
"name": "applicationInformationData",
197-
"description": "The Application Information data to be updated.",
198-
"required": true,
199-
"allowMultiple": true,
200-
"dataType": "string",
201-
"paramType": "body"
202-
}
203-
],
204-
"responseMessages":
205-
[
206-
{
207-
"code": 200,
208-
"message": "OK"
209-
},
210-
{
211-
"code": 201,
212-
"message": "Created"
213-
},
214-
{
215-
"code": 400,
216-
"message": "Bad Request"
217-
},
218-
{
219-
"code": 403,
220-
"message": "Forbidden"
221-
}
222-
]
223-
},
224-
{
225-
"method": "DELETE",
226-
"summary": "Delete an Application Information Structure [FB_41]",
227-
"notes": "To provide the required Bearer access token in the HTTP Authorization header, enter the <strong>\"data_custodian_access_token\"</strong> or <strong>\"registration_access_token\"</strong> in the appropriate field at the top of this web page!",
228-
"nickname": "deleteApplicationInformation",
229-
"authorizations": ["oauth2"],
230-
"parameters":
231-
[
232-
{
233-
"name": "applicationInformationId",
234-
"description": "The Id of the Application Information Structure to be deleted.",
235-
"required": true,
236-
"allowMultiple": true,
237-
"dataType": "String",
238-
"paramType": "path"
239-
}
240-
],
241-
"responseMessages":
242-
[
243-
{
244-
"code": 200,
245-
"message": "OK"
246-
},
247-
{
248-
"code": 400,
249-
"message": "Bad Request"
250-
},
251-
{
252-
"code": 403,
253-
"message": "Forbidden"
254-
},
255-
{
256-
"code": 404,
257-
"message": "Not Found"
258-
},
259-
{
260-
"code": 410,
261-
"message": "Gone"
262-
}
263-
]
264143
}
265144
]
266145
}

‎API/listings/Authorization‎

Lines changed: 0 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -190,93 +190,6 @@
190190
"message": "Forbidden"
191191
}
192192
]
193-
},
194-
{
195-
"method": "PUT",
196-
"summary": "Update an existing Data Custodian Authorization [FB_44]",
197-
"notes": "The Authorization must exist. To provide the required Bearer access token in the HTTP Authorization header, enter the <strong>\"data_custodian_access_token\"</strong> or <strong>\"client_access_token\"</strong> in the appropriate field at the top of this web page!",
198-
"nickname": "updateAuthorization",
199-
"consumes": ["application/atom+xml"],
200-
"authorizations": ["oauth2"],
201-
"parameters":
202-
[
203-
{
204-
"name": "authorizationId",
205-
"description": "Id of Authorization to be updated.",
206-
"required": true,
207-
"allowMultiple": false,
208-
"dataType": "Authorization",
209-
"paramType": "path"
210-
},
211-
{
212-
"name": "authorizationData",
213-
"description": "The Authorization's updated data.",
214-
"required": true,
215-
"allowMultiple": true,
216-
"dataType": "string",
217-
"paramType": "body"
218-
}
219-
220-
],
221-
"responseMessages": [
222-
{
223-
"code": 200,
224-
"message" : "OK"
225-
},
226-
{
227-
"code": 201,
228-
"message": "Created"
229-
},
230-
{
231-
"code": 400,
232-
"message": "Bad Request"
233-
},
234-
{
235-
"code": 403,
236-
"message": "Forbidden"
237-
}
238-
]
239-
},
240-
{
241-
"method": "DELETE",
242-
"summary": "Delete an existing Data Custodian Authorization [FB_44]",
243-
"notes": "To provide the required Bearer access token in the HTTP Authorization header, enter the <strong>\"data_custodian_access_token\"</strong> or <strong>\"client_access_token\"</strong> in the appropriate field at the top of this web page!",
244-
"nickname": "deleteAuthorization",
245-
"produces": ["application/xml"],
246-
"authorizations": ["oauth2"],
247-
"parameters":
248-
[
249-
{
250-
"name": "authorizationId",
251-
"description": "Id of Authorization to be deleted.",
252-
"required": true,
253-
"allowMultiple": false,
254-
"dataType": "string",
255-
"paramType": "path"
256-
}
257-
],
258-
"responseMessages": [
259-
{
260-
"code": 200,
261-
"message" : "OK"
262-
},
263-
{
264-
"code": 400,
265-
"message": "Bad Request"
266-
},
267-
{
268-
"code": 403,
269-
"message": "Forbidden"
270-
},
271-
{
272-
"code": 404,
273-
"message": "Not Found"
274-
},
275-
{
276-
"code": 410,
277-
"message": "Gone"
278-
}
279-
]
280193
}
281194
]
282195
}

0 commit comments

Comments
 (0)