Skip to content
This repository was archived by the owner on May 28, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .mvn/wrapper/maven-wrapper.properties
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 3 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.3</version>
<version>2.7.4</version>
<relativePath /> <!-- lookup parent from repository -->
</parent>

Expand All @@ -19,7 +19,7 @@
<description>KuFlow REST Client</description>

<properties>
<maven.version>3.8.5</maven.version>
<maven.version>3.8.6</maven.version>
<java.version>11</java.version>

<!-- Maven plugin dependencies -->
Expand All @@ -34,7 +34,7 @@
<swagger-annotations.version>1.6.2</swagger-annotations.version>

<!-- Spring dependencies -->
<spring-boot.version>2.7.3</spring-boot.version>
<spring-boot.version>2.7.4</spring-boot.version>

<!-- Application dependencies -->
<feign.version>11.7</feign.version>
Expand Down
73 changes: 72 additions & 1 deletion src/main/resources/openapi/specs/api.kuflow.com/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down