Skip to content

Fix preview tags for Task Management APIs (List, Get, Cancel tasks) #5330

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

Closed
wants to merge 1 commit into from
Closed

Fix preview tags for Task Management APIs (List, Get, Cancel tasks) #5330

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
76 changes: 71 additions & 5 deletions docs/examples/languageExamples.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11552,23 +11552,23 @@
"specification/inference/text_embedding/examples/request/TextEmbeddingRequestExample1.yaml": [
{
"language": "Python",
"code": "resp = client.inference.text_embedding(\n inference_id=\"my-cohere-endpoint\",\n input=\"The sky above the port was the color of television tuned to a dead channel.\",\n task_settings={\n \"input_type\": \"ingest\"\n },\n)"
"code": "resp = client.inference.text_embedding(\n inference_id=\"my-cohere-endpoint\",\n input=\"The sky above the port was the color of television tuned to a dead channel.\",\n input_type=\"ingest\",\n)"
},
{
"language": "JavaScript",
"code": "const response = await client.inference.textEmbedding({\n inference_id: \"my-cohere-endpoint\",\n input:\n \"The sky above the port was the color of television tuned to a dead channel.\",\n task_settings: {\n input_type: \"ingest\",\n },\n});"
"code": "const response = await client.inference.textEmbedding({\n inference_id: \"my-cohere-endpoint\",\n input:\n \"The sky above the port was the color of television tuned to a dead channel.\",\n input_type: \"ingest\",\n});"
},
{
"language": "Ruby",
"code": "response = client.inference.text_embedding(\n inference_id: \"my-cohere-endpoint\",\n body: {\n \"input\": \"The sky above the port was the color of television tuned to a dead channel.\",\n \"task_settings\": {\n \"input_type\": \"ingest\"\n }\n }\n)"
"code": "response = client.inference.text_embedding(\n inference_id: \"my-cohere-endpoint\",\n body: {\n \"input\": \"The sky above the port was the color of television tuned to a dead channel.\",\n \"input_type\": \"ingest\"\n }\n)"
},
{
"language": "PHP",
"code": "$resp = $client->inference()->textEmbedding([\n \"inference_id\" => \"my-cohere-endpoint\",\n \"body\" => [\n \"input\" => \"The sky above the port was the color of television tuned to a dead channel.\",\n \"task_settings\" => [\n \"input_type\" => \"ingest\",\n ],\n ],\n]);"
"code": "$resp = $client->inference()->textEmbedding([\n \"inference_id\" => \"my-cohere-endpoint\",\n \"body\" => [\n \"input\" => \"The sky above the port was the color of television tuned to a dead channel.\",\n \"input_type\" => \"ingest\",\n ],\n]);"
},
{
"language": "curl",
"code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"input\":\"The sky above the port was the color of television tuned to a dead channel.\",\"task_settings\":{\"input_type\":\"ingest\"}}' \"$ELASTICSEARCH_URL/_inference/text_embedding/my-cohere-endpoint\""
"code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"input\":\"The sky above the port was the color of television tuned to a dead channel.\",\"input_type\":\"ingest\"}' \"$ELASTICSEARCH_URL/_inference/text_embedding/my-cohere-endpoint\""
}
],
"specification/inference/put_jinaai/examples/request/PutJinaAiRequestExample1.yaml": [
Expand Down Expand Up @@ -14848,5 +14848,71 @@
"language": "curl",
"code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"query\":\"SELECT * FROM library ORDER BY page_count DESC LIMIT 5\"}' \"$ELASTICSEARCH_URL/_sql?format=txt\""
}
],
"specification/streams/logs_disable/examples/request/PostStreamsDisableRequestExample1.yaml": [
{
"language": "Python",
"code": "resp = client.streams.logs_disable()"
},
{
"language": "JavaScript",
"code": "const response = await client.streams.logsDisable();"
},
{
"language": "Ruby",
"code": "response = client.streams.logs_disable"
},
{
"language": "PHP",
"code": "$resp = $client->streams()->logsDisable();"
},
{
"language": "curl",
"code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_streams/logs/_disable\""
}
],
"specification/streams/status/examples/request/GetStreamsStatusRequestExample1.yaml": [
{
"language": "Python",
"code": "resp = client.streams.status()"
},
{
"language": "JavaScript",
"code": "const response = await client.streams.status();"
},
{
"language": "Ruby",
"code": "response = client.streams.status"
},
{
"language": "PHP",
"code": "$resp = $client->streams()->status();"
},
{
"language": "curl",
"code": "curl -X GET -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_streams/status\""
}
],
"specification/streams/logs_enable/examples/request/PostStreamsEnableRequestExample1.yaml": [
{
"language": "Python",
"code": "resp = client.streams.logs_enable()"
},
{
"language": "JavaScript",
"code": "const response = await client.streams.logsEnable();"
},
{
"language": "Ruby",
"code": "response = client.streams.logs_enable"
},
{
"language": "PHP",
"code": "$resp = $client->streams()->logsEnable();"
},
{
"language": "curl",
"code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" \"$ELASTICSEARCH_URL/_streams/logs/_enable\""
}
]
}
8 changes: 4 additions & 4 deletions output/openapi/elasticsearch-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

82 changes: 74 additions & 8 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion specification/tasks/cancel/CancelTasksRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import { TaskId } from '@_types/common'
* To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running.
* You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.
* @rest_spec_name tasks.cancel
* @availability stack since=2.3.0 stability=experimental
* @availability stack since=2.3.0 stability=stable
* @availability serverless stability=experimental visibility=private
* @cluster_privileges manage
* @doc_id tasks
Expand Down
2 changes: 1 addition & 1 deletion specification/tasks/get/GetTaskRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import { Duration } from '@_types/Time'
*
* If the task identifier is not found, a 404 response code indicates that there are no resources that match the request.
* @rest_spec_name tasks.get
* @availability stack since=5.0.0 stability=experimental
* @availability stack since=5.0.0 stability=stable
* @availability serverless stability=experimental visibility=public
* @cluster_privileges monitor
* @doc_id tasks
Expand Down
2 changes: 1 addition & 1 deletion specification/tasks/list/ListTasksRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ import { GroupBy } from '@tasks/_types/GroupBy'
* The `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.
* The `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request.
* @rest_spec_name tasks.list
* @availability stack since=2.3.0 stability=experimental
* @availability stack since=2.3.0 stability=stable
* @availability serverless stability=experimental visibility=private
* @cluster_privileges monitor
* @doc_id tasks
Expand Down