summaryrefslogtreecommitdiffstats
path: root/services/activity-spec/swagger-ui/api-docs/api.html
diff options
context:
space:
mode:
authorshrikantawachar <shrikant.awachar@amdocs.com>2018-03-22 15:01:28 +0530
committerOren Kleks <orenkle@amdocs.com>2018-03-22 15:02:46 +0000
commit79550d5dc1c5bcb79123128aa37b381a368e38d9 (patch)
tree0b8391355c6bcd5cafb2ae48ed2871fc905ca8e5 /services/activity-spec/swagger-ui/api-docs/api.html
parent473f768e025412d43afa1f403ba638b913ffce83 (diff)
Enhance Activity Spec
Enhance Activity Spec to include additional fields type and content. Change-Id: Ic39aa21ef265bf07a5522a2f46f84d378316c7aa Issue-ID: SDC-1048 Signed-off-by: shrikantawachar <shrikant.awachar@amdocs.com>
Diffstat (limited to 'services/activity-spec/swagger-ui/api-docs/api.html')
-rw-r--r--services/activity-spec/swagger-ui/api-docs/api.html683
1 files changed, 0 insertions, 683 deletions
diff --git a/services/activity-spec/swagger-ui/api-docs/api.html b/services/activity-spec/swagger-ui/api-docs/api.html
deleted file mode 100644
index 8ec70b32cf..0000000000
--- a/services/activity-spec/swagger-ui/api-docs/api.html
+++ /dev/null
@@ -1,683 +0,0 @@
-<!DOCTYPE html>
-<html>
-<title>API Document</title>
-
-<!--xmp theme="united" style="display:none;"-->
-<xmp theme="united" style="display:none;">
-#Rest API
-
-
-## HTTP:///activityspec-api
-
-
-Rest API Documentation
-
-
-
-**Version** v1.0, build #${buildNumber}
-
-
-
-
-
-
-
-
-
-
-
-
-# APIs
-
-
-## /v1.0/activity-spec
-
-
-### GET
-
-<a id="list">Get list of activity specs </a>
-
-
-
-
-
-
-
-
-
-#### Request
-
-
-**Content-Type: ** application/json
-
-##### Parameters
-
-<table border="1">
- <tr>
- <th>Name</th>
- <th>Located in</th>
- <th>Required</th>
- <th>Description</th>
- <th>Default</th>
- <th>Schema</th>
- </tr>
-
-
-
-<tr>
- <th>status</th>
- <td>query</td>
- <td>no</td>
- <td>Currently supported values: &#x27;Certified&#x27; - only activity specs with Certified status</td>
- <td> - </td>
-
-
- <td>string </td>
-
-
-</tr>
-
-<tr>
- <th>USER_ID</th>
- <td>header</td>
- <td>no</td>
- <td></td>
- <td> - </td>
-
-
- <td>string </td>
-
-
-</tr>
-
-
-</table>
-
-
-
-#### Response
-
-**Content-Type: ** application/json
-
-
-| Status Code | Reason | Response Model |
-|-------------|-------------|----------------|
-| default | successful operation | - |
-
-
-
-
-
-
-### POST
-
-
-<a id="createActivitySpec">Create Activity Spec</a>
-
-
-
-
-
-
-
-
-
-#### Request
-
-
-**Content-Type: ** application/json
-
-##### Parameters
-
-<table border="1">
- <tr>
- <th>Name</th>
- <th>Located in</th>
- <th>Required</th>
- <th>Description</th>
- <th>Default</th>
- <th>Schema</th>
- </tr>
-
-
-
-<tr>
- <th>body</th>
- <td>body</td>
- <td>no</td>
- <td></td>
- <td> - </td>
-
- <td>
-
- <a href="#/definitions/ActivitySpecRequest">ActivitySpecRequest</a>
- </td>
-
-</tr>
-
-<tr>
- <th>USER_ID</th>
- <td>header</td>
- <td>no</td>
- <td></td>
- <td> - </td>
-
-
- <td>string </td>
-
-
-</tr>
-
-
-</table>
-
-
-
-#### Response
-
-**Content-Type: ** application/json
-
-
-| Status Code | Reason | Response Model |
-|-------------|-------------|----------------|
-| default | successful operation | - |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-## /v1.0/activity-spec/{id}/versions/{versionId}
-
-
-### GET
-
-<a id="getActivitySpec">Get Activity Spec</a>
-
-
-
-
-
-
-
-
-
-#### Request
-
-
-**Content-Type: ** application/json
-
-##### Parameters
-
-<table border="1">
- <tr>
- <th>Name</th>
- <th>Located in</th>
- <th>Required</th>
- <th>Description</th>
- <th>Default</th>
- <th>Schema</th>
- </tr>
-
-
-
-<tr>
- <th>id</th>
- <td>path</td>
- <td>yes</td>
- <td>Activity Spec Id</td>
- <td> - </td>
-
-
- <td>string </td>
-
-
-</tr>
-
-<tr>
- <th>versionId</th>
- <td>path</td>
- <td>yes</td>
- <td>Version Id</td>
- <td> - </td>
-
-
- <td>string </td>
-
-
-</tr>
-
-<tr>
- <th>USER_ID</th>
- <td>header</td>
- <td>no</td>
- <td></td>
- <td> - </td>
-
-
- <td>string </td>
-
-
-</tr>
-
-
-</table>
-
-
-
-#### Response
-
-**Content-Type: ** application/json
-
-
-| Status Code | Reason | Response Model |
-|-------------|-------------|----------------|
-| default | successful operation | - |
-
-
-
-
-### PUT
-
-<a id="updateActivitySpec">Update Activity Spec</a>
-
-
-
-
-
-
-
-
-
-#### Request
-
-
-**Content-Type: ** application/json
-
-##### Parameters
-
-<table border="1">
- <tr>
- <th>Name</th>
- <th>Located in</th>
- <th>Required</th>
- <th>Description</th>
- <th>Default</th>
- <th>Schema</th>
- </tr>
-
-
-
-<tr>
- <th>body</th>
- <td>body</td>
- <td>no</td>
- <td></td>
- <td> - </td>
-
- <td>
-
- <a href="#/definitions/ActivitySpecRequest">ActivitySpecRequest</a>
- </td>
-
-</tr>
-
-<tr>
- <th>id</th>
- <td>path</td>
- <td>yes</td>
- <td>Activity Spec Id</td>
- <td> - </td>
-
-
- <td>string </td>
-
-
-</tr>
-
-<tr>
- <th>versionId</th>
- <td>path</td>
- <td>yes</td>
- <td>Version Id</td>
- <td> - </td>
-
-
- <td>string </td>
-
-
-</tr>
-
-<tr>
- <th>USER_ID</th>
- <td>header</td>
- <td>no</td>
- <td></td>
- <td> - </td>
-
-
- <td>string </td>
-
-
-</tr>
-
-
-</table>
-
-
-
-#### Response
-
-**Content-Type: ** application/json
-
-
-| Status Code | Reason | Response Model |
-|-------------|-------------|----------------|
-| default | successful operation | - |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-## /v1.0/activity-spec/{id}/versions/{versionId}/actions
-
-
-
-
-### PUT
-
-<a id="actOnActivitySpec">Actions on a activity spec</a>
-
-Performs one of the following actions on a activity spec: |Submit: Finalize its active version.|Deprecate: Deprecate activity spec.|
-
-
-
-
-
-
-
-#### Request
-
-
-**Content-Type: ** application/json
-
-##### Parameters
-
-<table border="1">
- <tr>
- <th>Name</th>
- <th>Located in</th>
- <th>Required</th>
- <th>Description</th>
- <th>Default</th>
- <th>Schema</th>
- </tr>
-
-
-
-<tr>
- <th>body</th>
- <td>body</td>
- <td>no</td>
- <td></td>
- <td> - </td>
-
- <td>
-
- <a href="#/definitions/ActivitySpecActionRequestDto">ActivitySpecActionRequestDto</a>
- </td>
-
-</tr>
-
-<tr>
- <th>id</th>
- <td>path</td>
- <td>yes</td>
- <td>Activity Spec Id</td>
- <td> - </td>
-
-
- <td>string </td>
-
-
-</tr>
-
-<tr>
- <th>versionId</th>
- <td>path</td>
- <td>yes</td>
- <td>Version Id</td>
- <td> - </td>
-
-
- <td>string </td>
-
-
-</tr>
-
-<tr>
- <th>USER_ID</th>
- <td>header</td>
- <td>no</td>
- <td></td>
- <td> - </td>
-
-
- <td>string </td>
-
-
-</tr>
-
-
-</table>
-
-
-
-#### Response
-
-**Content-Type: ** application/json
-
-
-| Status Code | Reason | Response Model |
-|-------------|-------------|----------------|
-| default | successful operation | - |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-# Definitions
-
-## <a name="/definitions/ActivitySpecActionRequestDto">ActivitySpecActionRequestDto</a>
-
-<table border="1">
- <tr>
- <th>name</th>
- <th>type</th>
- <th>required</th>
- <th>description</th>
- <th>example</th>
- </tr>
-
- <tr>
- <td>action</td>
- <td>
-
-
- string
-
- </td>
- <td>optional</td>
- <td>-</td>
- <td></td>
- </tr>
-
-</table>
-
-## <a name="/definitions/ActivitySpecParameterDto">ActivitySpecParameterDto</a>
-
-<table border="1">
- <tr>
- <th>name</th>
- <th>type</th>
- <th>required</th>
- <th>description</th>
- <th>example</th>
- </tr>
-
- <tr>
- <td>name</td>
- <td>
-
-
- string
-
- </td>
- <td>optional</td>
- <td>-</td>
- <td></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td>
-
-
- string
-
- </td>
- <td>optional</td>
- <td>-</td>
- <td></td>
- </tr>
-
- <tr>
- <td>value</td>
- <td>
-
-
- string
-
- </td>
- <td>optional</td>
- <td>-</td>
- <td></td>
- </tr>
-
-</table>
-
-## <a name="/definitions/ActivitySpecRequest">ActivitySpecRequest</a>
-
-<table border="1">
- <tr>
- <th>name</th>
- <th>type</th>
- <th>required</th>
- <th>description</th>
- <th>example</th>
- </tr>
-
- <tr>
- <td>name</td>
- <td>
-
-
- string
-
- </td>
- <td>optional</td>
- <td>-</td>
- <td></td>
- </tr>
-
- <tr>
- <td>description</td>
- <td>
-
-
- string
-
- </td>
- <td>optional</td>
- <td>-</td>
- <td></td>
- </tr>
-
- <tr>
- <td>categoryList</td>
- <td>
-
-
- array[string]
-
- </td>
- <td>optional</td>
- <td>-</td>
- <td></td>
- </tr>
-
- <tr>
- <td>inputParameters</td>
- <td>
-
-
- array[<a href="#/definitions/ActivitySpecParameterDto">ActivitySpecParameterDto</a>]
-
-
-
- </td>
- <td>optional</td>
- <td>-</td>
- <td></td>
- </tr>
-
- <tr>
- <td>outputParameters</td>
- <td>
-
-
- array[<a href="#/definitions/ActivitySpecParameterDto">ActivitySpecParameterDto</a>]
-
-
-
- </td>
- <td>optional</td>
- <td>-</td>
- <td></td>
- </tr>
-
-</table>
-
-</xmp>
-
-<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
-</html> \ No newline at end of file