From 17cb2a877cabcce568c565519d5e0cc659eb5fe3 Mon Sep 17 00:00:00 2001 From: Katarina Valalikova Date: Wed, 1 Mar 2017 19:40:21 +0100 Subject: [PATCH] swagger documentation + generated index.html --- config/rest/swagger.yml | 58 ++++++++++++++++++++++++++++++++++++++++- gui/admin-gui/pom.xml | 7 +++++ 2 files changed, 64 insertions(+), 1 deletion(-) diff --git a/config/rest/swagger.yml b/config/rest/swagger.yml index 228d597ab14..54819e9f0b4 100644 --- a/config/rest/swagger.yml +++ b/config/rest/swagger.yml @@ -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" @@ -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" diff --git a/gui/admin-gui/pom.xml b/gui/admin-gui/pom.xml index 1600742e0e2..b19ed6dc653 100644 --- a/gui/admin-gui/pom.xml +++ b/gui/admin-gui/pom.xml @@ -95,8 +95,15 @@ + + + org.webjars + swagger-ui + 2.2.5 + runtime + org.webjars.bower