Skip to content

Commit

Permalink
swagger documentation + generated index.html
Browse files Browse the repository at this point in the history
  • Loading branch information
katkav committed Mar 1, 2017
1 parent f2e3bc8 commit 17cb2a8
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 1 deletion.
58 changes: 57 additions & 1 deletion config/rest/swagger.yml
Expand Up @@ -224,7 +224,7 @@ paths:
post:
summary: "Validate value according to value policy"
description: "Validate value of some attribute according to value policy. Value policy is chosen according to the object identification provided in the path {type}, {oid}."
operationId: "getValuePolicyForUser"
operationId: "validateValue"
consumes:
- "application/json"
- "application/xml"
Expand Down Expand Up @@ -288,6 +288,62 @@ paths:
schema:
type: "object"
description: "see OperationResultType"
/users/{id}/policy:
get:
summary: "Get value policy specific for user"
description: "Get value policy specific for users. There might exist more value policies, e.g. different value policies for different tenants/organization units etc. "
operationId: "getValuePolicyForUser"
produces:
- "application/json"
- "application/xml"
- "application/yaml"
parameters:
- name: "id"
in: "path"
required: true
type: "string"
description: "oid of the user for which the value policy is returned"
responses:
200:
description: "Successful operation"
schema:
description: "see CredentialsPolicyType"
type: "object"
404:
description: "Requested object was not found."
schema:
type: "object"
description: "see OperationResultType"
503:
description: "Communication problem while provisioning"
schema:
type: "object"
description: "see OperationResultType"
403:
description: "Any of the security violations, e.g. insufficient access rights, ..."
schema:
type: "object"
description: "see OperationResultType"
502:
description: "Configuration problems"
schema:
type: "object"
description: "see OperationResultType"
406:
description: "Bad request, e.g. bad object in the request, missing mandatory fields, ..."
schema:
type: "object"
description: "see OperationResultType"
409:
description: "The same object already exists"
schema:
type: "object"
description: "see OperationResultType"
500:
description: "Any unknown error, mostly runtuime/unchecked exceptions"
schema:
type: "object"
description: "see OperationResultType"
/{type}:
post:
summary: "Add"
Expand Down
7 changes: 7 additions & 0 deletions gui/admin-gui/pom.xml
Expand Up @@ -95,8 +95,15 @@
</includes>
</testResource>
</testResources>

</build>
<dependencies>
<dependency>
<groupId>org.webjars</groupId>
<artifactId>swagger-ui</artifactId>
<version>2.2.5</version>
<scope>runtime</scope>
</dependency>
<!-- webjars -->
<dependency>
<groupId>org.webjars.bower</groupId>
Expand Down

0 comments on commit 17cb2a8

Please sign in to comment.