diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties index 687668b..dc3affc 100644 --- a/.mvn/wrapper/maven-wrapper.properties +++ b/.mvn/wrapper/maven-wrapper.properties @@ -14,5 +14,5 @@ # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. -distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.5/apache-maven-3.8.5-bin.zip +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.6/apache-maven-3.8.6-bin.zip wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar diff --git a/README.md b/README.md index 0c2964c..d43c3b1 100644 --- a/README.md +++ b/README.md @@ -22,3 +22,4 @@ We are happy to receive your help and comments, together we will dance a wonderf ## License [MIT License](LICENSE) + diff --git a/pom.xml b/pom.xml index 46984fb..27b5b68 100644 --- a/pom.xml +++ b/pom.xml @@ -6,20 +6,20 @@ org.springframework.boot spring-boot-starter-parent - 2.7.3 + 2.7.4 com.kuflow.rest.client kuflow-rest-client - 1.3.2 + 1.4.0 jar KuFlow REST Client KuFlow REST Client - 3.8.5 + 3.8.6 11 @@ -34,7 +34,7 @@ 1.6.2 - 2.7.3 + 2.7.4 11.7 diff --git a/src/main/resources/openapi/specs/api.kuflow.com/v1/openapi.yaml b/src/main/resources/openapi/specs/api.kuflow.com/v1/openapi.yaml index edee435..fe6cd12 100644 --- a/src/main/resources/openapi/specs/api.kuflow.com/v1/openapi.yaml +++ b/src/main/resources/openapi/specs/api.kuflow.com/v1/openapi.yaml @@ -42,6 +42,11 @@ security: - BasicAuth: [] tags: + - name: principal + description: Operations about principal. + externalDocs: + description: Find out more about our principal model. + url: "https://docs.kuflow.com/fine-grained-concepts/users-groups-roles" - name: process description: Operations about process externalDocs: @@ -92,13 +97,67 @@ paths: default: $ref: "#/components/responses/DefaultError" + /principals: + get: + summary: Find all accessible Principals + description: | + List all the Principals that have been created and the used credentials has access. + + Available sort query values: id, name + operationId: findPrincipals + tags: + - principal + parameters: + - $ref: "#/components/parameters/SizeQueryParam" + - $ref: "#/components/parameters/PageQueryParam" + - $ref: "#/components/parameters/SortQueryParam" + - name: type + in: query + schema: + $ref: "#/components/schemas/PrincipalType" + - name: groupId + in: query + schema: + type: array + items: + type: string + format: uuid + responses: + "200": + description: Principals found paginated + content: + application/json: + schema: + $ref: "#/components/schemas/PrincipalPage" + default: + $ref: "#/components/responses/DefaultError" + + /principals/{id}: + get: + summary: Get a Principal by Id + description: Returns the requested Principal when has access to do it. + operationId: retrievePrincipal + tags: + - principal + parameters: + - $ref: "#/components/parameters/IdPathParam" + responses: + "200": + description: Successful operation + content: + application/json: + schema: + $ref: "#/components/schemas/Principal" + default: + $ref: "#/components/responses/DefaultError" + /processes: get: summary: Find all accessible Processes description: | List all the Processes that have been created and the credentials has access. - Available sort query values: id, createAt, lastModifiedAt + Available sort query values: id, createdAt, lastModifiedAt operationId: findProcesses tags: - process @@ -1368,6 +1427,18 @@ components: - message - level + PrincipalPage: + allOf: + - $ref: "#/components/schemas/Page" + - type: object + properties: + content: + type: array + items: + $ref: "#/components/schemas/Principal" + required: + - content + Principal: type: object properties: