Differences

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

--- public:nnels:nnels_api_docs_v1:latest_resources [2019/05/14 18:08]
jonathan.schatz created
+++ public:nnels:nnels_api_docs_v1:latest_resources [2019/05/14 23:25]
jonathan.schatz [Auth endpoints]
@@ Line 1: / Line 1: @@
+===== Entities =====
+^ Resource URI    ^ Version       ^ Links to          ^ Linked by ^
+| repositoryItems    | 1.1     | fileResources, genre, subject, collection        | bookshelf, basicSearch |
+| fileResources    | 1.1 | - | - |
+| bookshelf   | 1.0    | repositoryItems        | - |
+| basicSearch   | 1.2    | repositoryItems       | - |
+| genres    | 1.0  | - | repositoryItems, basicSearch |
+| subjects | 1.0 | - |repositoryItems, basicSearch |
+| collections | 1.0 | repositoryItems, basicSearch| - |
+| users | 1.1 | bookshelf? | - |
-^ Resource URI    ^ Version       ^ Links to          ^ Linked by
+==== Properties ====
-| repositoryItems    | 1.1     |        |
-| fileResources    | 1.1 |
+^ Property ^ Name ^ Available From ^
-| bookshelf   | 1.0    |        |
+| Format | formats | repositoryItems, fileResources, bookshelf, basicSearch |
-| basicSearch   | 1.2    |        |
+| File size | filesize | repositoryItems, fileResources, basicSearch |
-| genre |  1.0  | | |
+| Signed download link | s3_path_signed | repositoryItems, fileResources, bookshelf|
-| subject | 1.0 | | |
+| Cover Art | cover_art | repositoryItems, bookshelf? |
+===== 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] |

User Tools

Differences

Page Tools

BC Libraries Coop wiki

Site Tools