Skip to content
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

Jump to bottom

feat(specs): add getAppTask endpoint to search #3156

Merged
merged 1 commit into from
Jun 11, 2024
Merged

feat(specs): add getAppTask endpoint to search #3156

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
38 changes: 38 additions & 0 deletions specs/search/paths/advanced/getAppTask.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
get:
tags:
- Advanced
operationId: getAppTask
x-acl:
- editSettings
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's weird to have this acl here, i'd have expected search

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could't find the doc, but its only used for dictionaries so I assumed it would have the same ACL

description: |
Checks the status of a given application task.
summary: Check application task status
parameters:
- name: taskID
in: path
description: Unique task identifier.
required: true
schema:
type: integer
format: int64
example: 1506303845001
responses:
'200':
description: OK
content:
application/json:
schema:
title: getTaskResponse
type: object
additionalProperties: false
properties:
status:
$ref: '../../common/enums.yml#/taskStatus'
required:
- status
'400':
$ref: '../../../common/responses/BadRequest.yml'
'402':
$ref: '../../../common/responses/FeatureNotEnabled.yml'
'403':
$ref: '../../../common/responses/MethodNotAllowed.yml'
2 changes: 2 additions & 0 deletions specs/search/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,8 @@ paths:
# ##########################
/1/logs:
$ref: 'paths/advanced/getLogs.yml'
/1/task/{taskID}:
$ref: 'paths/advanced/getAppTask.yml'
/1/indexes/{indexName}/task/{taskID}:
$ref: 'paths/advanced/getTask.yml'

Expand Down
11 changes: 11 additions & 0 deletions tests/CTS/requests/search/getAppTask.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[
{
"parameters": {
"taskID": 123
},
"request": {
"path": "/1/task/123",
"method": "GET"
}
}
]
Loading