AIL/ail-framework
7
0
Fork 0
mirror of https://github.com/ail-project/ail-framework.git synced 2024-11-10 08:38:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chg: [api] add api versioning

Browse source
This commit is contained in:
Terrtia 2019-08-05 09:46:56 +02:00
parent 5e1ae8a893
commit fea7b07134
No known key found for this signature in database
GPG key ID: 1E1B1F50D84613D0
2 changed files with 27 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
doc/README.md
View file

@ -27,7 +27,7 @@ curl --header "Authorization: YOUR_API_KEY" --header "Content-Type: application/
## Item management ## Item management
### Get item: `api/get/item/default/<path:item_id>` ### Get item: `api/v1/get/item/default/<path:item_id>`
#### Description #### Description
Get item default info. Get item default info.
@ -92,7 +92,7 @@ curl https://127.0.0.1:7000/api/get/item/default/submitted/2019/07/26/3efb8a79-0
### Get item content: `api/get/item/content/<path:item_id>` ### Get item content: `api/v1/get/item/content/<path:item_id>`
#### Description #### Description
Get a specific item content. Get a specific item content.
@ -141,7 +141,7 @@ curl https://127.0.0.1:7000/api/get/item/content/submitted/2019/07/26/3efb8a79-0
### Get item content: `api/get/item/tag/<path:item_id>` ### Get item content: `api/v1/get/item/tag/<path:item_id>`
#### Description #### Description
Get all tags from an item. Get all tags from an item.
@ -164,7 +164,7 @@ Get all tags from an item.
#### Example #### Example
``` ```
curl https://127.0.0.1:7000/api/get/item/tag/submitted/2019/07/26/3efb8a79-08e9-4776-94ab-615eb370b6d4.gz --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json" curl https://127.0.0.1:7000/api/v1/get/item/tag/submitted/2019/07/26/3efb8a79-08e9-4776-94ab-615eb370b6d4.gz --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json"
``` ```
#### Expected Success Response #### Expected Success Response
@ -197,7 +197,7 @@ curl https://127.0.0.1:7000/api/get/item/tag/submitted/2019/07/26/3efb8a79-08e9-
### Advanced Get item: `api/get/item` ### Advanced Get item: `api/v1/get/item`
#### Description #### Description
Get item. Filter requested field. Get item. Filter requested field.
@ -259,7 +259,7 @@ Get item. Filter requested field.
#### Example #### Example
``` ```
curl https://127.0.0.1:7000/api/get/item --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json" --data @input.json -X POST curl https://127.0.0.1:7000/api/v1/get/item --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json" --data @input.json -X POST
``` ```
#### input.json Example #### input.json Example
@ -306,7 +306,7 @@ curl https://127.0.0.1:7000/api/get/item --header "Authorization: iHc1_ChZxj1aXm
### add item tags: `api/add/item/tag` ### add item tags: `api/v1/add/item/tag`
#### Description #### Description
Add tags to an item. Add tags to an item.
@ -337,7 +337,7 @@ Add tags to an item.
#### Example #### Example
``` ```
curl https://127.0.0.1:7000/api/import/item --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json" --data @input.json -X POST curl https://127.0.0.1:7000/api/v1/import/item --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json" --data @input.json -X POST
``` ```
#### input.json Example #### input.json Example
@ -380,7 +380,7 @@ curl https://127.0.0.1:7000/api/import/item --header "Authorization: iHc1_ChZxj1
### Delete item tags: `api/delete/item/tag` ### Delete item tags: `api/v1/delete/item/tag`
#### Description #### Description
Delete tags from an item. Delete tags from an item.
@ -407,7 +407,7 @@ Delete tags from an item.
#### Example #### Example
``` ```
curl https://127.0.0.1:7000/api/delete/item/tag --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json" --data @input.json -X DELETE curl https://127.0.0.1:7000/api/v1/delete/item/tag --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json" --data @input.json -X DELETE
``` ```
#### input.json Example #### input.json Example
@ -452,7 +452,7 @@ curl https://127.0.0.1:7000/api/delete/item/tag --header "Authorization: iHc1_Ch
## Tag management ## Tag management
### Get all AIL tags: `api/get/tag/all` ### Get all AIL tags: `api/v1/get/tag/all`
#### Description #### Description
Get all tags used in AIL. Get all tags used in AIL.
@ -465,7 +465,7 @@ Get all tags used in AIL.
- *list* - *list*
#### Example #### Example
``` ```
curl https://127.0.0.1:7000/api/get/tag/all --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json" curl https://127.0.0.1:7000/api/v1/get/tag/all --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json"
``` ```
#### Expected Success Response #### Expected Success Response
@ -506,7 +506,7 @@ curl https://127.0.0.1:7000/api/get/tag/all --header "Authorization: iHc1_ChZxj1
### Get tag metadata: `api/get/tag/metadata/<tag>` ### Get tag metadata: `api/v1/get/tag/metadata/<tag>`
#### Description #### Description
Get tag metadata. Get tag metadata.
@ -531,7 +531,7 @@ Get tag metadata.
- *str - YYMMDD* - *str - YYMMDD*
#### Example #### Example
``` ```
curl https://127.0.0.1:7000/api/get/tag/metadata/infoleak:submission=\"manual\" --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json" curl https://127.0.0.1:7000/api/v1/get/tag/metadata/infoleak:submission=\"manual\" --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json"
``` ```
#### Expected Success Response #### Expected Success Response
@ -559,7 +559,7 @@ curl https://127.0.0.1:7000/api/get/tag/metadata/infoleak:submission=\"manual\"
### Import item (currently: text only): `api/import/item` ### Import item (currently: text only): `api/v1/import/item`
#### Description #### Description
Allows users to import new items. asynchronous function. Allows users to import new items. asynchronous function.
@ -595,7 +595,7 @@ Allows users to import new items. asynchronous function.
#### Example #### Example
``` ```
curl https://127.0.0.1:7000/api/import/item --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json" --data @input.json -X POST curl https://127.0.0.1:7000/api/v1/import/item --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json" --data @input.json -X POST
``` ```
#### input.json Example #### input.json Example
@ -632,7 +632,7 @@ curl https://127.0.0.1:7000/api/import/item --header "Authorization: iHc1_ChZxj1
### GET Import item info: `api/import/item/<uuid4>` ### GET Import item info: `api/v1/import/item/<uuid4>`
#### Description #### Description
@ -661,7 +661,7 @@ Get import status and all items imported by uuid
#### Example #### Example
``` ```
curl -k https://127.0.0.1:7000/api/import/item/b20a69f1-99ad-4cb3-b212-7ce24b763b50 --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json" curl -k https://127.0.0.1:7000/api/v1/import/item/b20a69f1-99ad-4cb3-b212-7ce24b763b50 --header "Authorization: iHc1_ChZxj1aXmiFiF1mkxxQkzawwriEaZpPqyTQj " -H "Content-Type: application/json"
``` ```
#### Expected Success Response #### Expected Success Response

18
var/www/modules/restApi/Flask_restApi.py
View file

@ -156,7 +156,7 @@ def one():
# } # }
# #
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
@restApi.route("api/get/item", methods=['GET', 'POST']) @restApi.route("api/v1/get/item", methods=['GET', 'POST'])
@token_required('admin') @token_required('admin')
def get_item_id(): def get_item_id():
if request.method == 'POST': if request.method == 'POST':
@ -166,7 +166,7 @@ def get_item_id():
else: else:
return 'description API endpoint' return 'description API endpoint'
@restApi.route("api/get/item/default/<path:item_id>", methods=['GET']) @restApi.route("api/v1/get/item/default/<path:item_id>", methods=['GET'])
@token_required('admin') @token_required('admin')
def get_item_id_basic(item_id): def get_item_id_basic(item_id):
""" """
@ -227,7 +227,7 @@ def get_item_id_basic(item_id):
# } # }
# #
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
@restApi.route("api/get/item/tag/<path:item_id>", methods=['GET']) @restApi.route("api/v1/get/item/tag/<path:item_id>", methods=['GET'])
@token_required('admin') @token_required('admin')
def get_item_tag(item_id): def get_item_tag(item_id):
""" """
@ -287,7 +287,7 @@ def get_item_tag(item_id):
# } # }
# #
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
@restApi.route("api/add/item/tag", methods=['POST']) @restApi.route("api/v1/add/item/tag", methods=['POST'])
@token_required('admin') @token_required('admin')
def add_item_tags(): def add_item_tags():
""" """
@ -370,7 +370,7 @@ def add_item_tags():
# } # }
# #
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
@restApi.route("api/delete/item/tag", methods=['DELETE']) @restApi.route("api/v1/delete/item/tag", methods=['DELETE'])
@token_required('admin') @token_required('admin')
def delete_item_tags(): def delete_item_tags():
""" """
@ -447,7 +447,7 @@ def delete_item_tags():
# } # }
# #
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
@restApi.route("api/get/item/content/<path:item_id>", methods=['GET']) @restApi.route("api/v1/get/item/content/<path:item_id>", methods=['GET'])
@token_required('admin') @token_required('admin')
def get_item_content(item_id): def get_item_content(item_id):
""" """
@ -489,7 +489,7 @@ def get_item_content(item_id):
# # # # # # # # # # # # # # TAGS # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # TAGS # # # # # # # # # # # # # # # # #
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
@restApi.route("api/get/tag/metadata/<tag>", methods=['GET']) @restApi.route("api/v1/get/tag/metadata/<tag>", methods=['GET'])
@token_required('admin') @token_required('admin')
def get_tag_metadata(tag): def get_tag_metadata(tag):
if not Tag.is_tag_in_all_tag(tag): if not Tag.is_tag_in_all_tag(tag):
@ -525,7 +525,7 @@ def get_all_tags():
# response: {"uuid": "uuid"} # response: {"uuid": "uuid"}
# #
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
@restApi.route("api/import/item", methods=['POST']) @restApi.route("api/v1/import/item", methods=['POST'])
@token_required('admin') @token_required('admin')
def import_item(): def import_item():
""" """
@ -624,7 +624,7 @@ def import_item():
# } # }
# #
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
@restApi.route("api/import/item/<UUID>", methods=['GET']) @restApi.route("api/v1/import/item/<UUID>", methods=['GET'])
@token_required('admin') @token_required('admin')
def import_item_uuid(UUID): def import_item_uuid(UUID):
""" """