Skip to content

Commit 6ef94a9

Browse files
chore(developer): update API docs (#794)
1 parent 085be4d commit 6ef94a9

2 files changed

Lines changed: 0 additions & 366 deletions

File tree

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

Lines changed: 0 additions & 216 deletions
Original file line numberDiff line numberDiff line change
@@ -6447,72 +6447,6 @@ paths:
64476447
$ref: '#/components/schemas/ServiceUnavailableExceptionResource'
64486448
x-doc-sections:
64496449
- file-based
6450-
/search/files:
6451-
get:
6452-
tags:
6453-
- Search
6454-
summary: 'Search Files'
6455-
description: "**Required scopes:** `project.source.file` (Read only).\n\nSearches source files by name/title across up to 50 caller-supplied projects."
6456-
operationId: api.search.files.getMany
6457-
parameters:
6458-
-
6459-
name: query
6460-
in: query
6461-
description: 'Search files by `name` or `title`'
6462-
required: true
6463-
schema:
6464-
type: string
6465-
maxLength: 128
6466-
-
6467-
name: projectIds
6468-
in: query
6469-
description: 'Project identifiers to search across. Get via [List Projects](#operation/api.projects.getMany). It can be one project or a list of comma-separated ones (max 50)'
6470-
required: true
6471-
schema:
6472-
type: string
6473-
example: '1,2,3'
6474-
-
6475-
$ref: '#/components/parameters/PaginationLimit'
6476-
-
6477-
$ref: '#/components/parameters/PaginationOffset'
6478-
responses:
6479-
'200':
6480-
description: 'Matched files'
6481-
content:
6482-
application/json:
6483-
schema:
6484-
$ref: '#/components/schemas/EnterpriseFileCollectionResource'
6485-
'400':
6486-
description: 'Invalid Request Parameters'
6487-
content:
6488-
application/json:
6489-
schema:
6490-
$ref: '#/components/schemas/ErrorCollectionResource'
6491-
example:
6492-
errors:
6493-
- { error: { key: query, errors: [{ code: isEmpty, message: "Value is required and can't be empty" }] } }
6494-
'404':
6495-
description: 'One of the requested projects was not found'
6496-
content:
6497-
application/json:
6498-
schema:
6499-
$ref: '#/components/schemas/NotFoundExceptionResource'
6500-
example:
6501-
error:
6502-
message: 'Project Not Found'
6503-
code: 404
6504-
'422':
6505-
description: 'The search was too broad to complete within the time limit'
6506-
content:
6507-
application/json:
6508-
schema:
6509-
$ref: '#/components/schemas/UnprocessableEntityExceptionResource'
6510-
example:
6511-
error:
6512-
message: 'The search was too broad to complete within the time limit'
6513-
code: 422
6514-
x-doc-sections:
6515-
- file-based
65166450
/glossaries:
65176451
get:
65186452
tags:
@@ -14377,82 +14311,6 @@ paths:
1437714311
application/json:
1437814312
schema:
1437914313
$ref: '#/components/schemas/ServiceUnavailableExceptionResource'
14380-
/search/strings:
14381-
get:
14382-
tags:
14383-
- Search
14384-
summary: 'Search Source Strings'
14385-
description: "**Required scopes:** `project.source.string` (Read only).\n\nSearches source strings by text/context/key across up to 50 caller-supplied projects."
14386-
operationId: api.search.strings.getMany
14387-
parameters:
14388-
-
14389-
name: query
14390-
in: query
14391-
description: 'Search strings by the fields selected in `scope`'
14392-
required: true
14393-
schema:
14394-
type: string
14395-
maxLength: 128
14396-
-
14397-
name: projectIds
14398-
in: query
14399-
description: 'Project identifiers to search across. Get via [List Projects](#operation/api.projects.getMany). It can be one project or a list of comma-separated ones (max 50)'
14400-
required: true
14401-
schema:
14402-
type: string
14403-
example: '1,2,3'
14404-
-
14405-
name: scope
14406-
in: query
14407-
description: 'Specify field to be the target of filtering. One of: `all`, `text`, `context`, `key`. Default is `all`'
14408-
schema:
14409-
type: string
14410-
default: all
14411-
enum:
14412-
- all
14413-
- text
14414-
- context
14415-
- key
14416-
-
14417-
$ref: '#/components/parameters/PaginationLimit'
14418-
-
14419-
$ref: '#/components/parameters/PaginationOffset'
14420-
responses:
14421-
'200':
14422-
description: 'Matched source strings'
14423-
content:
14424-
application/json:
14425-
schema:
14426-
$ref: '#/components/schemas/EnterpriseStringSearchCollectionResource'
14427-
'400':
14428-
description: 'Invalid Request Parameters'
14429-
content:
14430-
application/json:
14431-
schema:
14432-
$ref: '#/components/schemas/ErrorCollectionResource'
14433-
example:
14434-
errors:
14435-
- { error: { key: query, errors: [{ code: isEmpty, message: "Value is required and can't be empty" }] } }
14436-
'404':
14437-
description: 'One of the requested projects was not found'
14438-
content:
14439-
application/json:
14440-
schema:
14441-
$ref: '#/components/schemas/NotFoundExceptionResource'
14442-
example:
14443-
error:
14444-
message: 'Project Not Found'
14445-
code: 404
14446-
'422':
14447-
description: 'The search was too broad to complete within the time limit'
14448-
content:
14449-
application/json:
14450-
schema:
14451-
$ref: '#/components/schemas/UnprocessableEntityExceptionResource'
14452-
example:
14453-
error:
14454-
message: 'The search was too broad to complete within the time limit'
14455-
code: 422
1445614314
'/projects/{projectId}/comments/{commentId}/attachments/{attachmentId}':
1445714315
delete:
1445814316
tags:
@@ -16324,77 +16182,6 @@ paths:
1632416182
application/json:
1632516183
schema:
1632616184
$ref: '#/components/schemas/ServiceUnavailableExceptionResource'
16327-
/search/translations:
16328-
get:
16329-
tags:
16330-
- Search
16331-
summary: 'Search Translations'
16332-
description: "**Required scopes:** `project.translation` (Read only).\n\nSearches target-language translations by text across up to 50 caller-supplied projects."
16333-
operationId: api.search.translations.getMany
16334-
parameters:
16335-
-
16336-
name: query
16337-
in: query
16338-
description: 'Search translations by `text`'
16339-
required: true
16340-
schema:
16341-
type: string
16342-
maxLength: 128
16343-
-
16344-
name: projectIds
16345-
in: query
16346-
description: 'Project identifiers to search across. Get via [List Projects](#operation/api.projects.getMany). It can be one project or a list of comma-separated ones (max 50)'
16347-
required: true
16348-
schema:
16349-
type: string
16350-
example: '1,2,3'
16351-
-
16352-
name: languageIds
16353-
in: query
16354-
description: 'Filter by target language identifier. Get via [Project Target Languages](#operation/api.projects.get). It can be one language or a list of comma-separated ones'
16355-
schema:
16356-
type: string
16357-
example: 'uk,de'
16358-
-
16359-
$ref: '#/components/parameters/PaginationLimit'
16360-
-
16361-
$ref: '#/components/parameters/PaginationOffset'
16362-
responses:
16363-
'200':
16364-
description: 'Matched translations'
16365-
content:
16366-
application/json:
16367-
schema:
16368-
$ref: '#/components/schemas/EnterpriseTranslationSearchCollectionResource'
16369-
'400':
16370-
description: 'Invalid Request Parameters'
16371-
content:
16372-
application/json:
16373-
schema:
16374-
$ref: '#/components/schemas/ErrorCollectionResource'
16375-
example:
16376-
errors:
16377-
- { error: { key: query, errors: [{ code: isEmpty, message: "Value is required and can't be empty" }] } }
16378-
'404':
16379-
description: 'One of the requested projects was not found'
16380-
content:
16381-
application/json:
16382-
schema:
16383-
$ref: '#/components/schemas/NotFoundExceptionResource'
16384-
example:
16385-
error:
16386-
message: 'Project Not Found'
16387-
code: 404
16388-
'422':
16389-
description: 'The search was too broad to complete within the time limit'
16390-
content:
16391-
application/json:
16392-
schema:
16393-
$ref: '#/components/schemas/UnprocessableEntityExceptionResource'
16394-
example:
16395-
error:
16396-
message: 'The search was too broad to complete within the time limit'
16397-
code: 422
1639816185
'/projects/{projectId}/votes':
1639916186
get:
1640016187
tags:
@@ -55331,9 +55118,6 @@ tags:
5533155118
-
5533255119
name: 'Source Strings'
5533355120
description: "\nSource strings are the text units for translation. Instead of modifying source files, you can manage source strings one by one.\n\nUse API to add, edit, or delete some specific strings in the source-based and files-based projects (available only for the following file formats: CSV, RESX, JSON, Android XML, iOS strings, PROPERTIES, XLIFF).\n"
55334-
-
55335-
name: Search
55336-
description: 'Search across multiple projects in your organization in a single request.'
5533755121
-
5533855122
name: 'String/Asset Translations'
5533955123
description: 'Use API to add or remove strings/asset translations, approvals, and votes.'

0 commit comments

Comments
 (0)