ac4cc65cb5
Contains .inc files which have all the contents of the .rst files but are grouped together for easier editing. Contains parameters.yaml, which has all parameters in one file. Contains request and response samples (JSON and XML) that are pointed to from the .inc files. Change-Id: I42d5451300f95774a3ec4df66bc95cb36795844d
96 lines
1.3 KiB
ReStructuredText
96 lines
1.3 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=========
|
|
Resources
|
|
=========
|
|
|
|
Lists all and gets information for resources.
|
|
|
|
|
|
List resources
|
|
==============
|
|
|
|
.. rest_method:: GET /v2/resources
|
|
|
|
Lists definitions for all resources.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- q: q
|
|
- meter_links: meter_links
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- user_id: user_id
|
|
- links: links
|
|
- resource_id: resource_id
|
|
- source: source
|
|
- project_id: project_id
|
|
- metadata: metadata
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/resources-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Show resource details
|
|
=====================
|
|
|
|
.. rest_method:: GET /v2/resources/{resource_id}
|
|
|
|
Shows details for a resource, by resource ID.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- resource_id: resource_id
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- user_id: user_id
|
|
- links: links
|
|
- resource_id: resource_id
|
|
- source: source
|
|
- project_id: project_id
|
|
- metadata: metadata
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/resource-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|