User Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
public:nnels:nnels_api_docs_v1:latest_resources [2019/05/14 20:25]
jonathan.schatz
public:nnels:nnels_api_docs_v1:latest_resources [2019/07/09 17:26]
jonathan.schatz Added postman link
Line 1: Line 1:
 +=== Latest documentation ====
 +[[https://documenter.getpostman.com/view/998743/S1a8yjm2?version=latest|NNELS API on Postman]]
 +
 ===== Entities ===== ===== Entities =====
  
 ^ Resource URI    ^ Version       ^ Links to          ^ Linked by ^ ^ Resource URI    ^ Version       ^ Links to          ^ Linked by ^
 | repositoryItems    | 1.1     | fileResources, genre, subject, collection        | bookshelf, basicSearch | | repositoryItems    | 1.1     | fileResources, genre, subject, collection        | bookshelf, basicSearch |
-| fileResources    | 1.1 | - |  +| fileResources    | 1.1 | - | - | 
-| bookshelf   | 1.0    | repositoryItems        | +| bookshelf   | 1.0    | repositoryItems        | - 
-| basicSearch   | 1.2    | repositoryItems       |+| basicSearch   | 1.2    | repositoryItems       | - |
 | genres    | 1.0  | - | repositoryItems, basicSearch | | genres    | 1.0  | - | repositoryItems, basicSearch |
 | subjects | 1.0 | - |repositoryItems, basicSearch | | subjects | 1.0 | - |repositoryItems, basicSearch |
-| collections | 1.0 | repositoryItems, basicSearch| +| collections | 1.0 | repositoryItems, basicSearch| - 
-| users | 1.1 | bookshelf? | +| users | 1.1 | bookshelf? | - |
- +
-===== HTTP Methods ===== +
-All resources support GET, OPTIONS +
-bookshelf additionally supports POST (add to Bookshelf) +
- +
- +
-====== Other properties ======+
  
 +==== Properties ====
  
 ^ Property ^ Name ^ Available From ^ ^ Property ^ Name ^ Available From ^
Line 25: Line 22:
 | Cover Art | cover_art | repositoryItems, bookshelf? | | Cover Art | cover_art | repositoryItems, bookshelf? |
  
-Auth endpoints+ 
 +===== HTTP Methods ===== 
 +  * All resources support GET, OPTIONS 
 +  * bookshelf additionally supports POST (add to Bookshelf) 
 + 
 +===== Auth endpoints ===== 
 +^ Auth* ^ Resource URI ^ Example ^ 
 +| AuthN | login-token |  GET /api/login-token \\ Authorization: Basic [:basic_auth_hash]| 
 +| AuthZ | refresh-token |  GET /api/refresh-token/[:refresh_token] |
public/nnels/nnels_api_docs_v1/latest_resources.txt · Last modified: 2024/05/09 05:04 (external edit)