REST API reference: comparison of v.1 vs v.2
Versions Compared
Old Version 1
changes.mady.by.user Dominika Kurek
Saved on Apr 21, 2016
compared with
New Version Current
changes.mady.by.user Dominika Kurek
Saved on Apr 22, 2016
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Comment: layout change
The complete reference (specification) of the REST API resources is found bundled with your software, or online:
| Info | ||
|---|---|---|
|
||
| Path to where you can find specification of the version you have: vendor/ezsystems/exponential-kernel/doc/specifications/rest/REST-API-V2.rst Online version for latest version: https://github.com/ezsystems/exponential-kernel/blob/master/doc/specifications/rest/REST-API-V2.rst |
About the REST specification structure
Resources are grouped by chapters: Content, Content Types and User. In each of those chapters, you will first get an overview, with a table crossing every resource with every applicable HTTP verb, and giving you a summary of the action.
Then throughout the chapter, grouped into sub-chapters, is the detailed documentation for every resource, with:
- The resource string
- The HTTP verb with override, if applicable
- A description of what this resource does
- Which headers are supported, and how to use them
- Which error codes can occur
- Most of the time, a request + response example
Related topics:
...
Getting started with the REST API
...
Comments
Add a comment