diff --git a/docs/api/v1/openapi.yml b/docs/api/v1/openapi.yml index e0b05cc94..726cd5c44 100644 --- a/docs/api/v1/openapi.yml +++ b/docs/api/v1/openapi.yml @@ -1605,6 +1605,35 @@ paths: '404': $ref: '#/components/responses/notFound' /projects/{projectId}/users: + get: + x-eov-operation-id: getProjectUsers + x-eov-operation-handler: v1/handlers/projects/projects.handler + tags: + - Projects + summary: List project members + description: Returns a list of all members of a project including their role. Requires user:list scope. + parameters: + - name: projectId + in: path + description: The ID of the project. + required: true + schema: + type: string + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/cursor' + responses: + '200': + description: Operation successful. + content: + application/json: + schema: + $ref: '#/components/schemas/projectMemberList' + '401': + $ref: '#/components/responses/unauthorized' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/notFound' post: x-eov-operation-id: addUsersToProject x-eov-operation-handler: v1/handlers/projects/projects.handler @@ -2850,6 +2879,60 @@ components: description: Paginate through projects by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection. nullable: true example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA + projectMember: + type: object + description: A project member (user with their role in the project). + properties: + id: + type: string + description: The user's unique identifier. + readOnly: true + example: 123e4567-e89b-12d3-a456-426614174000 + email: + type: string + format: email + description: The user's email address. + readOnly: true + example: john.doe@company.com + firstName: + type: string + maxLength: 32 + description: The user's first name. + readOnly: true + example: john + lastName: + type: string + maxLength: 32 + description: The user's last name. + readOnly: true + example: Doe + createdAt: + type: string + format: date-time + description: When the user was created. + readOnly: true + updatedAt: + type: string + format: date-time + description: When the user was last updated. + readOnly: true + role: + type: string + description: The user's role in the project (e.g. project:admin, project:viewer). + readOnly: true + example: project:viewer + projectMemberList: + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/projectMember' + nextCursor: + type: string + description: Paginate through project members by setting the cursor parameter to the nextCursor attribute returned by a previous request. Default value fetches the first page of the collection. + nullable: true + example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA error: required: - message