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 20:26]
jonathan.schatz
@@ 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
+===== HTTP Methods =====
-| repositoryItems    | 1.1     |        |
+  * All resources support GET, OPTIONS
-| fileResources    | 1.1 |
+  * bookshelf additionally supports POST (add to Bookshelf)
-| bookshelf   | 1.0    |        |
-| basicSearch   | 1.2    |        |
-| genre |  1.0  | | |
+====== Other properties ======
-| subject | 1.0 | | |
+^ Property ^ Name ^ Available From ^
+| Format | formats | repositoryItems, fileResources, bookshelf, basicSearch |
+| File size | filesize | repositoryItems, fileResources, basicSearch |
+| Signed download link | s3_path_signed | repositoryItems, fileResources, bookshelf|
+| Cover Art | cover_art | repositoryItems, bookshelf? |
+Auth endpoints

User Tools

Differences

Page Tools

BC Libraries Coop wiki

Site Tools