Skip to content

Commit 6a71d69

Browse files
github-actions[bot]github-actions[bot]
authored
chore(developer): update API docs (#227)
1 parent c9745c9 commit 6a71d69

File tree

2 files changed

+196
-0
lines changed

2 files changed

+196
-0
lines changed

‎src/assets/api/enterprise/file-based.yml‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14189,6 +14189,44 @@ paths:
1418914189
summary: 'List Teams'
1419014190
operationId: api.teams.getMany
1419114191
parameters:
14192+
-
14193+
name: search
14194+
in: query
14195+
description: 'Search by `name`'
14196+
required: false
14197+
schema:
14198+
type: string
14199+
maxLength: 255
14200+
minLength: 2
14201+
-
14202+
name: projectIds
14203+
in: query
14204+
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'
14205+
required: false
14206+
schema:
14207+
type: string
14208+
-
14209+
name: projectRoles
14210+
in: query
14211+
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`"
14212+
required: false
14213+
schema:
14214+
type: string
14215+
example: 'manager,developer,language_coordinator'
14216+
-
14217+
name: languageIds
14218+
in: query
14219+
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'
14220+
required: false
14221+
schema:
14222+
type: string
14223+
-
14224+
name: groupIds
14225+
in: query
14226+
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'
14227+
required: false
14228+
schema:
14229+
type: string
1419214230
-
1419314231
name: orderBy
1419414232
in: query
@@ -16801,6 +16839,66 @@ paths:
1680116839
enum:
1680216840
- enabled
1680316841
- disabled
16842+
-
16843+
name: organizationRoles
16844+
in: query
16845+
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`"
16846+
required: false
16847+
schema:
16848+
type: string
16849+
example: 'manager,vendor,client'
16850+
-
16851+
name: teamId
16852+
in: query
16853+
description: 'Filter by team identifier. Get via [List Teams](#operation/api.teams.getMany)'
16854+
required: false
16855+
schema:
16856+
type: integer
16857+
-
16858+
name: projectIds
16859+
in: query
16860+
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'
16861+
required: false
16862+
schema:
16863+
type: string
16864+
-
16865+
name: projectRoles
16866+
in: query
16867+
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`"
16868+
required: false
16869+
schema:
16870+
type: string
16871+
example: 'manager,developer,language_coordinator'
16872+
-
16873+
name: languageIds
16874+
in: query
16875+
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'
16876+
required: false
16877+
schema:
16878+
type: string
16879+
-
16880+
name: groupIds
16881+
in: query
16882+
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'
16883+
required: false
16884+
schema:
16885+
type: string
16886+
-
16887+
name: lastSeenFrom
16888+
in: query
16889+
description: "Date in UTC, ISO 8601.\n\n__NOTE:__ Must be used together with `lastSeenTo`"
16890+
required: false
16891+
schema:
16892+
type: string
16893+
example: '2024-01-10T10:41:33+00:00'
16894+
-
16895+
name: lastSeenTo
16896+
in: query
16897+
description: "Date in UTC, ISO 8601.\n\n__NOTE:__ Must be used together with `lastSeenFrom`"
16898+
required: false
16899+
schema:
16900+
type: string
16901+
example: '2024-01-10T10:41:33+00:00'
1680416902
-
1680516903
$ref: '#/components/parameters/PaginationLimit'
1680616904
-

‎src/assets/api/enterprise/string-based.yml‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13319,6 +13319,44 @@ paths:
1331913319
summary: 'List Teams'
1332013320
operationId: api.teams.getMany
1332113321
parameters:
13322+
-
13323+
name: search
13324+
in: query
13325+
description: 'Search by `name`'
13326+
required: false
13327+
schema:
13328+
type: string
13329+
maxLength: 255
13330+
minLength: 2
13331+
-
13332+
name: projectIds
13333+
in: query
13334+
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'
13335+
required: false
13336+
schema:
13337+
type: string
13338+
-
13339+
name: projectRoles
13340+
in: query
13341+
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`"
13342+
required: false
13343+
schema:
13344+
type: string
13345+
example: 'manager,developer,language_coordinator'
13346+
-
13347+
name: languageIds
13348+
in: query
13349+
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'
13350+
required: false
13351+
schema:
13352+
type: string
13353+
-
13354+
name: groupIds
13355+
in: query
13356+
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'
13357+
required: false
13358+
schema:
13359+
type: string
1332213360
-
1332313361
name: orderBy
1332413362
in: query
@@ -15473,6 +15511,66 @@ paths:
1547315511
enum:
1547415512
- enabled
1547515513
- disabled
15514+
-
15515+
name: organizationRoles
15516+
in: query
15517+
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`"
15518+
required: false
15519+
schema:
15520+
type: string
15521+
example: 'manager,vendor,client'
15522+
-
15523+
name: teamId
15524+
in: query
15525+
description: 'Filter by team identifier. Get via [List Teams](#operation/api.teams.getMany)'
15526+
required: false
15527+
schema:
15528+
type: integer
15529+
-
15530+
name: projectIds
15531+
in: query
15532+
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'
15533+
required: false
15534+
schema:
15535+
type: string
15536+
-
15537+
name: projectRoles
15538+
in: query
15539+
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`"
15540+
required: false
15541+
schema:
15542+
type: string
15543+
example: 'manager,developer,language_coordinator'
15544+
-
15545+
name: languageIds
15546+
in: query
15547+
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'
15548+
required: false
15549+
schema:
15550+
type: string
15551+
-
15552+
name: groupIds
15553+
in: query
15554+
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'
15555+
required: false
15556+
schema:
15557+
type: string
15558+
-
15559+
name: lastSeenFrom
15560+
in: query
15561+
description: "Date in UTC, ISO 8601.\n\n__NOTE:__ Must be used together with `lastSeenTo`"
15562+
required: false
15563+
schema:
15564+
type: string
15565+
example: '2024-01-10T10:41:33+00:00'
15566+
-
15567+
name: lastSeenTo
15568+
in: query
15569+
description: "Date in UTC, ISO 8601.\n\n__NOTE:__ Must be used together with `lastSeenFrom`"
15570+
required: false
15571+
schema:
15572+
type: string
15573+
example: '2024-01-10T10:41:33+00:00'
1547615574
-
1547715575
$ref: '#/components/parameters/PaginationLimit'
1547815576
-

0 commit comments

Comments
 (0)