From ac134cb099afa6be09fbc5cdad5db0bcf7aee08a Mon Sep 17 00:00:00 2001 From: Kiran Kamineni Date: Fri, 4 May 2018 16:50:39 -0700 Subject: Adding a docs folder under sms repo WORK IN PROGRESS Adding a docs folder under sms Issue-ID: AAF-185 Change-Id: I5ee3560cfda2100ad5207bb7e98d5cb9472e1325 Signed-off-by: Girish Havaldar --- sms-service/doc/api_swagger.html | 732 ------------------- sms-service/doc/api_swagger.yaml | 288 -------- sms-service/doc/coverage.html | 1471 -------------------------------------- sms-service/doc/coverage.md | 41 -- 4 files changed, 2532 deletions(-) delete mode 100644 sms-service/doc/api_swagger.html delete mode 100644 sms-service/doc/api_swagger.yaml delete mode 100644 sms-service/doc/coverage.html delete mode 100644 sms-service/doc/coverage.md (limited to 'sms-service') diff --git a/sms-service/doc/api_swagger.html b/sms-service/doc/api_swagger.html deleted file mode 100644 index 7f987a3..0000000 --- a/sms-service/doc/api_swagger.html +++ /dev/null @@ -1,732 +0,0 @@ - - - - Secret Management Service - - - -

Secret Management Service

-
This is a service that provides secret management facilities
-
More information: https://helloreverb.com
- -
Version: 1.0.0
-
BasePath:/v1/sms/
-
Apache 2.0
-
http://www.apache.org/licenses/LICENSE-2.0.html
-

Access

-
    -
  1. APIKey KeyParamName:token KeyInQuery:false KeyInHeader:true
  2. -
- -

Methods

- [ Jump to Models ] - -

Table of Contents

-
-

Domain

- -

Login

- -

Secret

- -

System

- - -

Domain

-
-
- Up -
delete /domain/{domainName}
-
Deletes a domain by name (domainDomainNameDelete)
-
Deletes a domain with provided name
- -

Path parameters

-
-
domainName (required)
- -
Path Parameter — Name of the domain
-
- - - - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
  • -
- -

Responses

-

204

- Successful Deletion - -

404

- Invalid Path or Path not found - -
-
-
-
- Up -
post /domain
-
Add a new domain (domainPost)
-
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
  • -
- -

Request body

-
-
body Domain (required)
- -
Body Parameter
- -
- - - - -

Return type

-
- Domain - -
- - - -

Example data

-
Content-Type: application/json
-
{
-  "name" : "name",
-  "uuid" : "uuid"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
  • -
- -

Responses

-

201

- Successful Creation - Domain -

400

- Invalid input - -

500

- Internal Server Error - -
-
-

Login

-
-
- Up -
post /login
-
Login with username and password (loginPost)
-
Operations related to logging in via username and Password
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
  • -
- -

Request body

-
-
body Credential (required)
- -
Body Parameter
- -
- - - - -

Return type

- - - - -

Example data

-
Content-Type: application/json
-
{
-  "ttl" : 0,
-  "token" : "token"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
  • -
- -

Responses

-

200

- Successful Login returns a token - inline_response_200 -

404

- Invalid Username or Password - -
-
-

Secret

-
-
- Up -
get /domain/{domainName}/secret
-
List secret Names in this domain (domainDomainNameSecretGet)
-
Gets all secret names in this domain
- -

Path parameters

-
-
domainName (required)
- -
Path Parameter — Name of the domain in which to look at
-
- - - - - - -

Return type

- - - - -

Example data

-
Content-Type: application/json
-
"{\"secretnames\":[\"secretname1\",\"secretname2\",\"secretname3\"]}"
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
  • -
- -

Responses

-

200

- Successful operation - inline_response_200_2 -

404

- Invalid Path or Path not found - -
-
-
-
- Up -
post /domain/{domainName}/secret
-
Add a new secret (domainDomainNameSecretPost)
-
- -

Path parameters

-
-
domainName (required)
- -
Path Parameter — Name of the domain
-
- -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
  • -
- -

Request body

-
-
body Secret (required)
- -
Body Parameter
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
  • -
- -

Responses

-

201

- Successful Creation - -

404

- Invalid Path or Path not found - -
-
-
-
- Up -
delete /domain/{domainName}/secret/{secretName}
-
Deletes a Secret (domainDomainNameSecretSecretNameDelete)
-
- -

Path parameters

-
-
secretName (required)
- -
Path Parameter — Name of Secret to Delete
domainName (required)
- -
Path Parameter — Path to the SecretDomain which contains the Secret
-
- - - - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
  • -
- -

Responses

-

204

- Successful Deletion - -

404

- Invalid Path or Path not found - -
-
-
-
- Up -
get /domain/{domainName}/secret/{secretName}
-
Find Secret by Name (domainDomainNameSecretSecretNameGet)
-
Returns a single secret
- -

Path parameters

-
-
domainName (required)
- -
Path Parameter — Name of the domain in which to look at
secretName (required)
- -
Path Parameter — Name of the secret which is needed
-
- - - - - - -

Return type

-
- Secret - -
- - - -

Example data

-
Content-Type: application/json
-
{
-  "values" : {
-    "name" : "john",
-    "Age" : 40,
-    "admin" : true
-  },
-  "name" : "name"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
  • -
- -

Responses

-

200

- successful operation - Secret -

404

- Invalid Path or Path not found - -
-
-

System

-
-
- Up -
get /status
-
Get backend status (statusGet)
-
Gets current backend status. This API is used only by quorum clients
- - - - - - - -

Return type

- - - - -

Example data

-
Content-Type: application/json
-
{
-  "sealstatus" : "sealstatus"
-}
- -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
  • -
- -

Responses

-

200

- Successful operation - inline_response_200_1 -

404

- Invalid Path or Path not found - -
-
-
-
- Up -
post /unseal
-
Unseal backend (unsealPost)
-
Sends unseal shard to unseal if backend is sealed
- - -

Consumes

- This API call consumes the following media types via the Content-Type request header: -
    -
  • application/json
  • -
- -

Request body

-
-
body body (required)
- -
Body Parameter
- -
- - - - - - - - -

Produces

- This API call produces the following media types according to the Accept request header; - the media type will be conveyed by the Content-Type response header. -
    -
  • application/json
  • -
- -

Responses

-

201

- Submitted unseal key - -

404

- Invalid Path or Path not found - -
-
- -

Models

- [ Jump to Methods ] - -

Table of Contents

-
    -
  1. Credential -
  2. -
  3. Domain -
  4. -
  5. Secret -
  6. -
  7. body -
  8. -
  9. inline_response_200 -
  10. -
  11. inline_response_200_1 -
  12. -
  13. inline_response_200_2 -
  14. -
- -
-

Credential - Up

-
-
-
username (optional)
-
password (optional)
-
-
-
-

Domain - Up

-
-
-
uuid (optional)
String Optional value provided by user. If user does not provide, server will auto generate
-
name (optional)
String Name of the secret domain under which all secrets will be stored
-
-
-
-

Secret - Up

-
-
-
name (optional)
String Name of the secret
-
values (optional)
map[String, Object] Map of key value pairs that constitute the secret
-
-
-
-

body - Up

- -
-
unsealshard (optional)
String Unseal shard that will be used along with other shards to unseal backend
-
-
-
-

inline_response_200 - Up

- -
-
token (optional)
-
ttl (optional)
Integer ttl of returned token in seconds
-
-
-
-

inline_response_200_1 - Up

- -
-
sealstatus (optional)
String seal status of backend
-
-
-
-

inline_response_200_2 - Up

- -
-
secretnames (optional)
array[String] Array of strings referencing the secret names
-
-
- - diff --git a/sms-service/doc/api_swagger.yaml b/sms-service/doc/api_swagger.yaml deleted file mode 100644 index 61cd091..0000000 --- a/sms-service/doc/api_swagger.yaml +++ /dev/null @@ -1,288 +0,0 @@ -swagger: '2.0' -info: - description: This is a service that provides secret management facilities - version: 1.0.0 - title: Secret Management Service - contact: - email: kiran.k.kamineni@intel.com - license: - name: Apache 2.0 - url: 'http://www.apache.org/licenses/LICENSE-2.0.html' -host: 'aaf.onap.org:10443' -basePath: /v1/sms/ -tags: - - name: system - description: Operations related to quorum client which are not useful to clients - - name: login - description: Operations related to username password based authentication - - name: domain - description: Operations related to Secret Domains - - name: secret - description: Operations related to Secrets -schemes: - - https -paths: - /login: - post: - tags: - - login - summary: Login with username and password - description: Operations related to logging in via username and Password - consumes: - - application/json - produces: - - application/json - parameters: - - name: body - in: body - required: true - schema: - $ref: '#/definitions/Credential' - responses: - '200': - description: Successful Login returns a token - schema: - type: object - properties: - token: - type: string - ttl: - type: integer - description: ttl of returned token in seconds - '404': - description: Invalid Username or Password - /status: - get: - tags: - - system - description: Gets current backend status. This API is used only by quorum clients - summary: Get backend status - produces: - - application/json - responses: - '200': - description: Successful operation - schema: - type: object - properties: - sealstatus: - type: string - description: seal status of backend - '404': - description: Invalid Path or Path not found - /unseal: - post: - tags: - - system - description: Sends unseal shard to unseal if backend is sealed - summary: Unseal backend - consumes: - - application/json - produces: - - application/json - parameters: - - in: body - name: body - required: true - schema: - type: object - properties: - unsealshard: - type: string - description: >- - Unseal shard that will be used along with other shards to - unseal backend - responses: - '201': - description: Submitted unseal key - '404': - description: Invalid Path or Path not found - /domain: - post: - tags: - - domain - summary: Add a new domain - description: '' - consumes: - - application/json - produces: - - application/json - parameters: - - in: body - name: body - required: true - schema: - $ref: '#/definitions/Domain' - responses: - '201': - description: Successful Creation - schema: - $ref: '#/definitions/Domain' - '400': - description: Invalid input - '500': - description: Internal Server Error - '/domain/{domainName}': - delete: - tags: - - domain - description: Deletes a domain with provided name - summary: Deletes a domain by name - produces: - - application/json - parameters: - - name: domainName - in: path - description: Name of the domain - required: true - type: string - responses: - '204': - description: Successful Deletion - '404': - description: Invalid Path or Path not found - '/domain/{domainName}/secret': - post: - tags: - - secret - summary: Add a new secret - description: '' - consumes: - - application/json - produces: - - application/json - parameters: - - name: domainName - in: path - description: Name of the domain - required: true - type: string - - name: body - in: body - required: true - schema: - $ref: '#/definitions/Secret' - responses: - '201': - description: Successful Creation - '404': - description: Invalid Path or Path not found - get: - tags: - - secret - description: Gets all secret names in this domain - summary: List secret Names in this domain - produces: - - application/json - parameters: - - name: domainName - in: path - description: Name of the domain in which to look at - required: true - type: string - responses: - '200': - description: Successful operation - schema: - type: object - properties: - secretnames: - type: array - items: - type: string - description: Array of strings referencing the secret names - example: - secretnames: ["secretname1", "secretname2", "secretname3"] - '404': - description: Invalid Path or Path not found - '/domain/{domainName}/secret/{secretName}': - get: - tags: - - secret - summary: Find Secret by Name - description: Returns a single secret - produces: - - application/json - parameters: - - name: domainName - in: path - description: Name of the domain in which to look at - required: true - type: string - - name: secretName - in: path - description: Name of the secret which is needed - required: true - type: string - responses: - '200': - description: successful operation - schema: - $ref: '#/definitions/Secret' - '404': - description: Invalid Path or Path not found - delete: - tags: - - secret - summary: Deletes a Secret - description: '' - produces: - - application/json - parameters: - - name: secretName - in: path - description: Name of Secret to Delete - required: true - type: string - - name: domainName - in: path - required: true - description: Path to the SecretDomain which contains the Secret - type: string - responses: - '204': - description: Successful Deletion - '404': - description: Invalid Path or Path not found -securityDefinitions: - token: - type: apiKey - name: token - in: header -definitions: - Credential: - type: object - properties: - username: - type: string - password: - type: string - Domain: - type: object - properties: - uuid: - type: string - description: >- - Optional value provided by user. If user does not provide, server will - auto generate - name: - type: string - description: Name of the secret domain under which all secrets will be stored - Secret: - type: object - properties: - name: - type: string - description: Name of the secret - values: - description: Map of key value pairs that constitute the secret - type: object - additionalProperties: - type: object - example: - name: john - Age: 40 - admin: true -externalDocs: - description: Find out more about Swagger - url: 'http://swagger.io' diff --git a/sms-service/doc/coverage.html b/sms-service/doc/coverage.html deleted file mode 100644 index 39ee191..0000000 --- a/sms-service/doc/coverage.html +++ /dev/null @@ -1,1471 +0,0 @@ - - - - - - - - -
- -
- not tracked - - no coverage - low coverage - * - * - * - * - * - * - * - * - high coverage - -
-
-
- - - - - - - - - - - - - - - -
- - - diff --git a/sms-service/doc/coverage.md b/sms-service/doc/coverage.md deleted file mode 100644 index 6168342..0000000 --- a/sms-service/doc/coverage.md +++ /dev/null @@ -1,41 +0,0 @@ -## Code Coverage Reports for Golang Applications ## - -This document covers how to generate HTML Code Coverage Reports for -Golang Applications. - -#### Generate a test executable which calls your main() - -```sh -$ go test -c -covermode=count -coverpkg ./... -``` - -#### Run the generated application to produce a new coverage report - -```sh -$ ./sms.test -test.run "^TestMain$" -test.coverprofile=coverage.cov -``` - -#### Run your unit tests to produce their coverage report - -```sh -$ go test -test.covermode=count -test.coverprofile=unit.out ./... -``` - -#### Merge the two coverage Reports - -```sh -$ go get github.com/wadey/gocovmerge -$ gocovmerge unit.out coverage.cov > all.out -``` - -#### Generate HTML Report - -```sh -$ go tool cover -html all.out -o coverage.html -``` - -#### Generate Function Report - -```sh -$ go tool cover -func all.out -``` \ No newline at end of file -- cgit