diff options
author | Kai <lukai@chinamobile.com> | 2020-11-13 17:03:52 +0800 |
---|---|---|
committer | Kai <lukai@chinamobile.com> | 2020-11-13 17:05:51 +0800 |
commit | 6c9735ac3be12a4a1926fd50bdf4e8b59c712ff2 (patch) | |
tree | 34eed2aad1e08aacec75047eb4a79e738838b773 /docs/sections/apis | |
parent | e21c848562599340a99fc216bdaae97686d92a72 (diff) |
Add des rst
Issue-ID: DCAEGEN2-2507
Signed-off-by: Kai Lu <lukai@chinamobile.com>
Change-Id: I63161a3d2f7364c3689b93de25c4251c6e06d7c5
Diffstat (limited to 'docs/sections/apis')
-rw-r--r-- | docs/sections/apis/des_api.json | 67 | ||||
-rw-r--r-- | docs/sections/apis/des_api.rst | 28 |
2 files changed, 95 insertions, 0 deletions
diff --git a/docs/sections/apis/des_api.json b/docs/sections/apis/des_api.json new file mode 100644 index 00000000..0db3b4df --- /dev/null +++ b/docs/sections/apis/des_api.json @@ -0,0 +1,67 @@ +{ + "swagger": "2.0", + "info": { + "description": "This page lists all the rest apis for DataLake.", + "version": "1.1.0", + "title": "DataLake Extraction Service Rest APIs" + }, + "host": "r-node-1:31157/datalake/v1/", + "basePath": "/", + "tags": [{ + "name": "des-controller", + "description": "DES Controller" + }], + "paths": { + "/exposure/{serviceId}": { + "post": { + "tags": ["des-controller"], + "summary": "Datalake Data Extraction Service.", + "operationId": "serveUsingPOST", + "consumes": ["application/json"], + "produces": ["application/json"], + "parameters": [{ + "in": "body", + "name": "requestMap", + "description": "requestMap", + "required": true, + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, { + "name": "serviceId", + "in": "path", + "description": "serviceId", + "required": true, + "type": "string" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "deprecated": false + } + } + } +}
\ No newline at end of file diff --git a/docs/sections/apis/des_api.rst b/docs/sections/apis/des_api.rst new file mode 100644 index 00000000..57e68ca9 --- /dev/null +++ b/docs/sections/apis/des_api.rst @@ -0,0 +1,28 @@ +.. This work is licensed under a + Creative Commons Attribution 4.0 International License. + +================================= +DES (DataLake Extraction Service) +================================= + +:Date: 2020-11-11 + +.. contents:: + :depth: 3 + +Overview +======== + +Component description is included in `DES`_. + +.. _DES: ../../sections/services/datalake-handler/index.html + +Offered APIs +============ + +.. csv-table:: + :header: "API name", "Swagger JSON" + :widths: 10,5 + + "Datafile Collector API", ":download:`link <des_api.json>`" + |