diff --git a/doc/README.md b/doc/README.md index d832a3e6..3bce7ee8 100644 --- a/doc/README.md +++ b/doc/README.md @@ -18,6 +18,7 @@ When submitting data in a POST, PUT or DELETE operation you need to specify in w ~~~~ Content-Type: application/json ~~~~ +Take me to [delete_item_tag](#delete_item_tag) Example: @@ -25,11 +26,9 @@ Example: curl --header "Authorization: YOUR_API_KEY" --header "Content-Type: application/json" https://AIL_URL/ ~~~~ -Take me to [get_item_content](#get_item_content) - ## Item management -### Get item: `api/v1/get/item/default` +### Get item: `api/v1/get/item/default` #### Description Get item default info. @@ -101,7 +100,7 @@ curl https://127.0.0.1:7000/api/v1/get/item/default --header "Authorization: iHc -### Get item content: `api/v1/get/item/content` +### Get item content: `api/v1/get/item/content` #### Description Get a specific item content. @@ -157,7 +156,7 @@ curl https://127.0.0.1:7000/api/v1/get/item/content --header "Authorization: iHc -### Get item content: `api/v1/get/item/tag` +### Get item content: `api/v1/get/item/tag` #### Description Get all tags from an item. @@ -220,7 +219,7 @@ curl https://127.0.0.1:7000/api/v1/get/item/tag --header "Authorization: iHc1_Ch -### Advanced Get item: `api/v1/get/item` +### Advanced Get item: `api/v1/get/item` #### Description Get item. Filter requested field. @@ -329,7 +328,7 @@ curl https://127.0.0.1:7000/api/v1/get/item --header "Authorization: iHc1_ChZxj1 -### add item tags: `api/v1/add/item/tag` +### add item tags: `api/v1/add/item/tag` #### Description Add tags to an item. @@ -403,7 +402,7 @@ curl https://127.0.0.1:7000/api/v1/import/item --header "Authorization: iHc1_ChZ -### Delete item tags: `api/v1/delete/item/tag` +### Delete item tags: `api/v1/delete/item/tag` #### Description Delete tags from an item. @@ -475,7 +474,7 @@ curl https://127.0.0.1:7000/api/v1/delete/item/tag --header "Authorization: iHc1 ## Tag management -### Get all AIL tags: `api/v1/get/tag/all` +### Get all AIL tags: `api/v1/get/tag/all` #### Description Get all tags used in AIL. @@ -529,7 +528,7 @@ curl https://127.0.0.1:7000/api/v1/get/tag/all --header "Authorization: iHc1_ChZ -### Get tag metadata: `api/v1/get/tag/metadata` +### Get tag metadata: `api/v1/get/tag/metadata` #### Description Get tag metadata. @@ -589,7 +588,7 @@ curl https://127.0.0.1:7000/api/v1/get/tag/metadata --header "Authorization: iHc -### Import item (currently: text only): `api/v1/import/item` +### Import item (currently: text only): `api/v1/import/item` #### Description Allows users to import new items. asynchronous function. @@ -662,7 +661,7 @@ curl https://127.0.0.1:7000/api/v1/import/item --header "Authorization: iHc1_ChZ -### GET Import item info: `api/v1/get/import/item/` +### GET Import item info: `api/v1/get/import/item/` #### Description