Skip to content

chore(developer): update API docs #227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrii-bodnar merged 1 commit into from
Mar 14, 2025
Merged

chore(developer): update API docs #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
98 changes: 98 additions & 0 deletions src/assets/api/enterprise/file-based.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14189,6 +14189,44 @@ paths:
summary: 'List Teams'
operationId: api.teams.getMany
parameters:
-
name: search
in: query
description: 'Search by `name`'
required: false
schema:
type: string
maxLength: 255
minLength: 2
-
name: projectIds
in: query
description: 'Filter by project identifier. Get via [List Projects](#operation/api.projects.getMany). It can be one project or a list of comma-separated ones'
required: false
schema:
type: string
-
name: projectRoles
in: query
description: "Filter by role in project. It can be one role or a list of comma-separated ones.\n\nPossible values: `manager`, `developer`, `translator`, `proofreader`, `language_coordinator`, `member`"
required: false
schema:
type: string
example: 'manager,developer,language_coordinator'
-
name: languageIds
in: query
description: 'Filter project languages. Get via [List Supported Languages](#operation/api.languages.getMany). It can be one language or a list of comma-separated ones'
required: false
schema:
type: string
-
name: groupIds
in: query
description: 'Filter by group identifier. Get via [List Groups](#operation/api.groups.getMany). It can be one group or a list of comma-separated ones'
required: false
schema:
type: string
-
name: orderBy
in: query
Expand Down Expand Up @@ -16801,6 +16839,66 @@ paths:
enum:
- enabled
- disabled
-
name: organizationRoles
in: query
description: "Filter by role in organization. It can be one role or a list of comma-separated ones.\n\nPossible values: `admin`, `manager`, `vendor`, `client`"
required: false
schema:
type: string
example: 'manager,vendor,client'
-
name: teamId
in: query
description: 'Filter by team identifier. Get via [List Teams](#operation/api.teams.getMany)'
required: false
schema:
type: integer
-
name: projectIds
in: query
description: 'Filter by project identifier. Get via [List Projects](#operation/api.projects.getMany). It can be one project or a list of comma-separated ones'
required: false
schema:
type: string
-
name: projectRoles
in: query
description: "Filter by role in project. It can be one role or a list of comma-separated ones.\n\nPossible values: `manager`, `developer`, `translator`, `proofreader`, `language_coordinator`, `member`"
required: false
schema:
type: string
example: 'manager,developer,language_coordinator'
-
name: languageIds
in: query
description: 'Filter project languages. Get via [List Supported Languages](#operation/api.languages.getMany). It can be one language or a list of comma-separated ones'
required: false
schema:
type: string
-
name: groupIds
in: query
description: 'Filter by group identifier. Get via [List Groups](#operation/api.groups.getMany). It can be one group or a list of comma-separated ones'
required: false
schema:
type: string
-
name: lastSeenFrom
in: query
description: "Date in UTC, ISO 8601.\n\n__NOTE:__ Must be used together with `lastSeenTo`"
required: false
schema:
type: string
example: '2024-01-10T10:41:33+00:00'
-
name: lastSeenTo
in: query
description: "Date in UTC, ISO 8601.\n\n__NOTE:__ Must be used together with `lastSeenFrom`"
required: false
schema:
type: string
example: '2024-01-10T10:41:33+00:00'
-
$ref: '#/components/parameters/PaginationLimit'
-
Expand Down
98 changes: 98 additions & 0 deletions src/assets/api/enterprise/string-based.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13319,6 +13319,44 @@ paths:
summary: 'List Teams'
operationId: api.teams.getMany
parameters:
-
name: search
in: query
description: 'Search by `name`'
required: false
schema:
type: string
maxLength: 255
minLength: 2
-
name: projectIds
in: query
description: 'Filter by project identifier. Get via [List Projects](#operation/api.projects.getMany). It can be one project or a list of comma-separated ones'
required: false
schema:
type: string
-
name: projectRoles
in: query
description: "Filter by role in project. It can be one role or a list of comma-separated ones.\n\nPossible values: `manager`, `developer`, `translator`, `proofreader`, `language_coordinator`, `member`"
required: false
schema:
type: string
example: 'manager,developer,language_coordinator'
-
name: languageIds
in: query
description: 'Filter project languages. Get via [List Supported Languages](#operation/api.languages.getMany). It can be one language or a list of comma-separated ones'
required: false
schema:
type: string
-
name: groupIds
in: query
description: 'Filter by group identifier. Get via [List Groups](#operation/api.groups.getMany). It can be one group or a list of comma-separated ones'
required: false
schema:
type: string
-
name: orderBy
in: query
Expand Down Expand Up @@ -15473,6 +15511,66 @@ paths:
enum:
- enabled
- disabled
-
name: organizationRoles
in: query
description: "Filter by role in organization. It can be one role or a list of comma-separated ones.\n\nPossible values: `admin`, `manager`, `vendor`, `client`"
required: false
schema:
type: string
example: 'manager,vendor,client'
-
name: teamId
in: query
description: 'Filter by team identifier. Get via [List Teams](#operation/api.teams.getMany)'
required: false
schema:
type: integer
-
name: projectIds
in: query
description: 'Filter by project identifier. Get via [List Projects](#operation/api.projects.getMany). It can be one project or a list of comma-separated ones'
required: false
schema:
type: string
-
name: projectRoles
in: query
description: "Filter by role in project. It can be one role or a list of comma-separated ones.\n\nPossible values: `manager`, `developer`, `translator`, `proofreader`, `language_coordinator`, `member`"
required: false
schema:
type: string
example: 'manager,developer,language_coordinator'
-
name: languageIds
in: query
description: 'Filter project languages. Get via [List Supported Languages](#operation/api.languages.getMany). It can be one language or a list of comma-separated ones'
required: false
schema:
type: string
-
name: groupIds
in: query
description: 'Filter by group identifier. Get via [List Groups](#operation/api.groups.getMany). It can be one group or a list of comma-separated ones'
required: false
schema:
type: string
-
name: lastSeenFrom
in: query
description: "Date in UTC, ISO 8601.\n\n__NOTE:__ Must be used together with `lastSeenTo`"
required: false
schema:
type: string
example: '2024-01-10T10:41:33+00:00'
-
name: lastSeenTo
in: query
description: "Date in UTC, ISO 8601.\n\n__NOTE:__ Must be used together with `lastSeenFrom`"
required: false
schema:
type: string
example: '2024-01-10T10:41:33+00:00'
-
$ref: '#/components/parameters/PaginationLimit'
-
Expand Down