summaryrefslogtreecommitdiffstats
path: root/services/activity-spec/swagger-ui/api-docs
diff options
context:
space:
mode:
Diffstat (limited to 'services/activity-spec/swagger-ui/api-docs')
-rw-r--r--services/activity-spec/swagger-ui/api-docs/api.html683
-rw-r--r--services/activity-spec/swagger-ui/api-docs/api.json239
2 files changed, 0 insertions, 922 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
diff --git a/services/activity-spec/swagger-ui/api-docs/api.json b/services/activity-spec/swagger-ui/api-docs/api.json
deleted file mode 100644
index 7f99775fcd..0000000000
--- a/services/activity-spec/swagger-ui/api-docs/api.json
+++ /dev/null
@@ -1,239 +0,0 @@
-{
- "swagger" : "2.0",
- "info" : {
- "description" : "Rest API Documentation",
- "version" : "v1.0, build #${buildNumber}",
- "title" : "Rest API",
- "termsOfService" : "http://www.github.com/kongchen/swagger-maven-plugin"
- },
- "basePath" : "/activityspec-api",
- "tags" : [ {
- "name" : "Activity Specs"
- } ],
- "schemes" : [ "http" ],
- "paths" : {
- "/v1.0/activity-spec" : {
- "get" : {
- "tags" : [ "Activity Specs" ],
- "summary" : "Get list of activity specs ",
- "description" : "",
- "operationId" : "list",
- "consumes" : [ "application/json" ],
- "produces" : [ "application/json" ],
- "parameters" : [ {
- "name" : "status",
- "in" : "query",
- "description" : "Currently supported values: 'Certified' - only activity specs with Certified status",
- "required" : false,
- "type" : "string"
- }, {
- "name" : "USER_ID",
- "in" : "header",
- "required" : false,
- "type" : "string",
- "default" : ""
- } ],
- "responses" : {
- "default" : {
- "description" : "successful operation"
- }
- }
- },
- "post" : {
- "tags" : [ "Activity Specs" ],
- "summary" : "Create Activity Spec",
- "description" : "",
- "operationId" : "createActivitySpec",
- "consumes" : [ "application/json" ],
- "produces" : [ "application/json" ],
- "parameters" : [ {
- "in" : "body",
- "name" : "body",
- "required" : false,
- "schema" : {
- "$ref" : "#/definitions/ActivitySpecRequest"
- }
- }, {
- "name" : "USER_ID",
- "in" : "header",
- "required" : false,
- "type" : "string",
- "default" : ""
- } ],
- "responses" : {
- "default" : {
- "description" : "successful operation"
- }
- }
- }
- },
- "/v1.0/activity-spec/{id}/versions/{versionId}" : {
- "get" : {
- "tags" : [ "Activity Specs" ],
- "summary" : "Get Activity Spec",
- "description" : "",
- "operationId" : "getActivitySpec",
- "consumes" : [ "application/json" ],
- "produces" : [ "application/json" ],
- "parameters" : [ {
- "name" : "id",
- "in" : "path",
- "description" : "Activity Spec Id",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "versionId",
- "in" : "path",
- "description" : "Version Id",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "USER_ID",
- "in" : "header",
- "required" : false,
- "type" : "string",
- "default" : ""
- } ],
- "responses" : {
- "default" : {
- "description" : "successful operation"
- }
- }
- },
- "put" : {
- "tags" : [ "Activity Specs" ],
- "summary" : "Update Activity Spec",
- "description" : "",
- "operationId" : "updateActivitySpec",
- "consumes" : [ "application/json" ],
- "produces" : [ "application/json" ],
- "parameters" : [ {
- "in" : "body",
- "name" : "body",
- "required" : false,
- "schema" : {
- "$ref" : "#/definitions/ActivitySpecRequest"
- }
- }, {
- "name" : "id",
- "in" : "path",
- "description" : "Activity Spec Id",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "versionId",
- "in" : "path",
- "description" : "Version Id",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "USER_ID",
- "in" : "header",
- "required" : false,
- "type" : "string",
- "default" : ""
- } ],
- "responses" : {
- "default" : {
- "description" : "successful operation"
- }
- }
- }
- },
- "/v1.0/activity-spec/{id}/versions/{versionId}/actions" : {
- "put" : {
- "tags" : [ "Activity Specs" ],
- "summary" : "Actions on a activity spec",
- "description" : "Performs one of the following actions on a activity spec: |Submit: Finalize its active version.|Deprecate: Deprecate activity spec.|",
- "operationId" : "actOnActivitySpec",
- "consumes" : [ "application/json" ],
- "produces" : [ "application/json" ],
- "parameters" : [ {
- "in" : "body",
- "name" : "body",
- "required" : false,
- "schema" : {
- "$ref" : "#/definitions/ActivitySpecActionRequestDto"
- }
- }, {
- "name" : "id",
- "in" : "path",
- "description" : "Activity Spec Id",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "versionId",
- "in" : "path",
- "description" : "Version Id",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "USER_ID",
- "in" : "header",
- "required" : false,
- "type" : "string",
- "default" : ""
- } ],
- "responses" : {
- "default" : {
- "description" : "successful operation"
- }
- }
- }
- }
- },
- "definitions" : {
- "ActivitySpecActionRequestDto" : {
- "type" : "object",
- "properties" : {
- "action" : {
- "type" : "string",
- "enum" : [ "Certify", "Deprecate", "Delete" ]
- }
- }
- },
- "ActivitySpecParameterDto" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- },
- "value" : {
- "type" : "string"
- }
- }
- },
- "ActivitySpecRequest" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "description" : {
- "type" : "string"
- },
- "categoryList" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- },
- "inputParameters" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/ActivitySpecParameterDto"
- }
- },
- "outputParameters" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/ActivitySpecParameterDto"
- }
- }
- }
- }
- }
-} \ No newline at end of file