Skip to content

feat(API): Document new query parameters #393

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
Mikko Karkee (Varpuspaavi) merged 4 commits into from
Aug 28, 2023
Merged

feat(API): Document new query parameters #393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
732d439
feat: Document new query parameters
Varpuspaavi Aug 24, 2023
3f72cb3
Adjust CLI source
Varpuspaavi Aug 28, 2023
6371c8b
Fix x-code-sample for curl
Varpuspaavi Aug 28, 2023
c3f129e
Generate doc
Varpuspaavi Aug 28, 2023
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
149 changes: 145 additions & 4 deletions doc/compiled.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10378,6 +10378,44 @@
"schema": {
"type": "string"
}
},
{
"description": "Search query for comment messages",
"example": "Some comment content",
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Search comments by their assigned locales",
"example": [
"someId"
],
"name": "locale_ids",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"description": "Specify the filter for the comments",
"name": "filters",
"in": "query",
"schema": {
"type": "array",
"example": [
"read",
"unread"
],
"items": {
"type": "string"
}
}
}
],
"responses": {
Expand Down Expand Up @@ -10421,13 +10459,58 @@
"x-code-samples": [
{
"lang": "Curl",
"source": "curl \"https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments?branch=my-feature-branch\" \\\n -u USERNAME_OR_ACCESS_TOKEN"
"source": "curl \"https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments?branch=my-feature-branch&filters=unread&query=something&locale_ids=someId\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -X GET \\\n -H 'Content-Type: application/json'"
},
{
"lang": "CLI v2",
"source": "phrase comments list \\\n--project_id <project_id> \\\n--key_id <key_id> \\\n--branch my-feature-branch \\\n--access_token <token>"
"source": "phrase comments list \\\n--project_id <project_id> \\\n--key_id <key_id> \\\n--branch \"my-feature-branch\" \\\n--filters unread \\\n--query \"Some comment content\" \\\n--locale_ids someId \\\n--access_token <token>"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "comments/list/parameters",
"properties": {
"branch": {
"description": "Specify the branch to use",
"type": "string",
"example": "my-feature-branch"
},
"query": {
"description": "Search query for comment messages",
"type": "string",
"example": "Some comment content"
},
"locale_ids": {
"description": "Search comments by their assigned locales",
"type": "array",
"items": {
"type": "string"
},
"example": [
"someId",
"otherId"
]
},
"filters": {
"description": "Specify filters to find comments by",
"type": "array",
"items": {
"type": "string"
},
"example": [
"read",
"unread"
]
}
}
}
}
}
},
"x-cli-version": "2.5"
},
"post": {
Expand Down Expand Up @@ -11292,6 +11375,30 @@
"schema": {
"type": "string"
}
},
{
"description": "Search query for comment messages",
"example": "Some comment content",
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Specify the filter for the comments",
"name": "filters",
"in": "query",
"schema": {
"type": "array",
"example": [
"read",
"unread"
],
"items": {
"type": "string"
}
}
}
],
"responses": {
Expand Down Expand Up @@ -11338,13 +11445,47 @@
"x-code-samples": [
{
"lang": "Curl",
"source": "curl \"https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments/:comment_id/replies\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -X GET \\\n -d '{\"branch\":\"my-feature-branch\"}' \\\n -H 'Content-Type: application/json'"
"source": "curl \"https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments/:comment_id/replies?branch=my-feature-branch&filters=unread&query=something\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -X GET \\\n -H 'Content-Type: application/json'"
},
{
"lang": "CLI v2",
"source": "phrase replies list \\\n--project_id <project_id> \\\n--key_id <key_id> \\\n--comment_id <comment_id> \\\n--data '{\"branch\":\"my-feature-branch\"]}' \\\n--access_token <token>"
"source": "phrase replies list \\\n--project_id <project_id> \\\n--key_id <key_id> \\\n--comment_id <comment_id> \\\n--branch \"my-feature-branch\" \\\n--filters unread \\\n--query \"Some comment content\" \\\n--access_token <token>"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "replies/list/parameters",
"properties": {
"branch": {
"description": "Specify the branch to use",
"type": "string",
"example": "my-feature-branch"
},
"query": {
"description": "Search query for comment messages",
"type": "string",
"example": "Some comment content"
},
"filters": {
"description": "Specify filters to find comments by",
"type": "array",
"items": {
"type": "string"
},
"example": [
"read",
"unread"
]
}
}
}
}
}
},
"x-cli-version": "2.10"
},
"post": {
Expand Down
43 changes: 40 additions & 3 deletions paths/comment_replies/index.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,20 @@ parameters:
in: query
schema:
type: string
- description: Search query for comment messages
example: Some comment content
name: query
in: query
schema:
type: string
- description: Specify the filter for the comments
name: filters
in: query
schema:
type: array
example: [read, unread]
items:
type: string
responses:
'200':
description: OK
Expand Down Expand Up @@ -46,17 +60,40 @@ responses:
x-code-samples:
- lang: Curl
source: |-
curl "https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments/:comment_id/replies" \
curl "https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments/:comment_id/replies?branch=my-feature-branch&filters=unread&query=something" \
-u USERNAME_OR_ACCESS_TOKEN \
-X GET \
-d '{"branch":"my-feature-branch"}' \
-H 'Content-Type: application/json'
- lang: CLI v2
source: |-
phrase replies list \
--project_id <project_id> \
--key_id <key_id> \
--comment_id <comment_id> \
--data '{"branch":"my-feature-branch"]}' \
--branch "my-feature-branch" \
--filters unread \
--query "Some comment content" \
--access_token <token>
requestBody:
required: true
content:
application/json:
schema:
type: object
title: replies/list/parameters
properties:
branch:
description: Specify the branch to use
type: string
example: my-feature-branch
query:
description: Search query for comment messages
type: string
example: Some comment content
filters:
description: Specify filters to find comments by
type: array
items:
type: string
example: [read, unread]
x-cli-version: '2.10'
61 changes: 58 additions & 3 deletions paths/comments/index.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,28 @@ parameters:
in: query
schema:
type: string
- description: Search query for comment messages
example: Some comment content
name: query
in: query
schema:
type: string
- description: Search comments by their assigned locales
example: [someId]
name: locale_ids
in: query
schema:
type: array
items:
type: string
- description: Specify the filter for the comments
name: filters
in: query
schema:
type: array
example: [read, unread]
items:
type: string
responses:
'200':
description: OK
Expand Down Expand Up @@ -43,13 +65,46 @@ responses:
x-code-samples:
- lang: Curl
source: |-
curl "https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments?branch=my-feature-branch" \
-u USERNAME_OR_ACCESS_TOKEN
curl "https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments?branch=my-feature-branch&filters=unread&query=something&locale_ids=someId" \
-u USERNAME_OR_ACCESS_TOKEN \
-X GET \
-H 'Content-Type: application/json'
- lang: CLI v2
source: |-
phrase comments list \
--project_id <project_id> \
--key_id <key_id> \
--branch my-feature-branch \
--branch "my-feature-branch" \
--filters unread \
--query "Some comment content" \
--locale_ids someId \
--access_token <token>
requestBody:
required: true
content:
application/json:
schema:
type: object
title: comments/list/parameters
properties:
branch:
description: Specify the branch to use
type: string
example: my-feature-branch
query:
description: Search query for comment messages
type: string
example: Some comment content
locale_ids:
description: Search comments by their assigned locales
type: array
items:
type: string
example: [someId, otherId]
filters:
description: Specify filters to find comments by
type: array
items:
type: string
example: [read, unread]
x-cli-version: '2.5'