Skip to content

Removed /api/v1 prefix for HTTP paths #410

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
cretz merged 1 commit into from
May 24, 2024
Merged

Removed /api/v1 prefix for HTTP paths #410

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
88 changes: 44 additions & 44 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"application/json"
],
"paths": {
"/api/v1/cluster-info": {
"/cluster-info": {
"get": {
"summary": "GetClusterInfo returns information about temporal cluster",
"operationId": "GetClusterInfo",
Expand All @@ -42,7 +42,7 @@
]
}
},
"/api/v1/namespaces": {
"/namespaces": {
"get": {
"summary": "ListNamespaces returns the information and configuration for all namespaces.",
"operationId": "ListNamespaces",
Expand Down Expand Up @@ -120,7 +120,7 @@
]
}
},
"/api/v1/namespaces/{namespace}": {
"/namespaces/{namespace}": {
"get": {
"summary": "DescribeNamespace returns the information and configuration for a registered namespace.",
"operationId": "DescribeNamespace",
Expand Down Expand Up @@ -157,7 +157,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/activities/cancel": {
"/namespaces/{namespace}/activities/cancel": {
"post": {
"summary": "RespondActivityTaskFailed is called by workers when processing an activity task fails.",
"description": "This results in a new `ACTIVITY_TASK_CANCELED` event being written to the workflow history\nand a new workflow task created for the workflow. Fails with `NotFound` if the task token is\nno longer valid due to activity timeout, already being completed, or never having existed.",
Expand Down Expand Up @@ -197,7 +197,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/activities/cancel-by-id": {
"/namespaces/{namespace}/activities/cancel-by-id": {
"post": {
"summary": "See `RecordActivityTaskCanceled`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
"operationId": "RespondActivityTaskCanceledById",
Expand Down Expand Up @@ -237,7 +237,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/activities/complete": {
"/namespaces/{namespace}/activities/complete": {
"post": {
"summary": "RespondActivityTaskCompleted is called by workers when they successfully complete an activity\ntask.",
"description": "This results in a new `ACTIVITY_TASK_COMPLETED` event being written to the workflow history\nand a new workflow task created for the workflow. Fails with `NotFound` if the task token is\nno longer valid due to activity timeout, already being completed, or never having existed.",
Expand Down Expand Up @@ -277,7 +277,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/activities/complete-by-id": {
"/namespaces/{namespace}/activities/complete-by-id": {
"post": {
"summary": "See `RecordActivityTaskCompleted`. This version allows clients to record completions by\nnamespace/workflow id/activity id instead of task token.",
"operationId": "RespondActivityTaskCompletedById",
Expand Down Expand Up @@ -317,7 +317,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/activities/fail": {
"/namespaces/{namespace}/activities/fail": {
"post": {
"summary": "RespondActivityTaskFailed is called by workers when processing an activity task fails.",
"description": "This results in a new `ACTIVITY_TASK_FAILED` event being written to the workflow history and\na new workflow task created for the workflow. Fails with `NotFound` if the task token is no\nlonger valid due to activity timeout, already being completed, or never having existed.",
Expand Down Expand Up @@ -357,7 +357,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/activities/fail-by-id": {
"/namespaces/{namespace}/activities/fail-by-id": {
"post": {
"summary": "See `RecordActivityTaskFailed`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
"operationId": "RespondActivityTaskFailedById",
Expand Down Expand Up @@ -397,7 +397,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/activities/heartbeat": {
"/namespaces/{namespace}/activities/heartbeat": {
"post": {
"summary": "RecordActivityTaskHeartbeat is optionally called by workers while they execute activities.",
"description": "If worker fails to heartbeat within the `heartbeat_timeout` interval for the activity task,\nthen it will be marked as timed out and an `ACTIVITY_TASK_TIMED_OUT` event will be written to\nthe workflow history. Calling `RecordActivityTaskHeartbeat` will fail with `NotFound` in\nsuch situations, in that event, the SDK should request cancellation of the activity.",
Expand Down Expand Up @@ -437,7 +437,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/activities/heartbeat-by-id": {
"/namespaces/{namespace}/activities/heartbeat-by-id": {
"post": {
"summary": "See `RecordActivityTaskHeartbeat`. This version allows clients to record heartbeats by\nnamespace/workflow id/activity id instead of task token.",
"operationId": "RecordActivityTaskHeartbeatById",
Expand Down Expand Up @@ -477,7 +477,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/archived-workflows": {
"/namespaces/{namespace}/archived-workflows": {
"get": {
"summary": "ListArchivedWorkflowExecutions is a visibility API to list archived workflow executions in a specific namespace.",
"operationId": "ListArchivedWorkflowExecutions",
Expand Down Expand Up @@ -528,7 +528,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/batch-operations": {
"/namespaces/{namespace}/batch-operations": {
"get": {
"summary": "ListBatchOperations returns a list of batch operations",
"operationId": "ListBatchOperations",
Expand Down Expand Up @@ -576,7 +576,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/batch-operations/{jobId}": {
"/namespaces/{namespace}/batch-operations/{jobId}": {
"get": {
"summary": "DescribeBatchOperation returns the information about a batch operation",
"operationId": "DescribeBatchOperation",
Expand Down Expand Up @@ -660,7 +660,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/batch-operations/{jobId}/stop": {
"/namespaces/{namespace}/batch-operations/{jobId}/stop": {
"post": {
"summary": "StopBatchOperation stops a batch operation",
"operationId": "StopBatchOperation",
Expand Down Expand Up @@ -707,7 +707,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/schedules": {
"/namespaces/{namespace}/schedules": {
"get": {
"summary": "List all schedules in a namespace.",
"operationId": "ListSchedules",
Expand Down Expand Up @@ -762,7 +762,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/schedules/{scheduleId}": {
"/namespaces/{namespace}/schedules/{scheduleId}": {
"get": {
"summary": "Returns the schedule description and current state of an existing schedule.",
"operationId": "DescribeSchedule",
Expand Down Expand Up @@ -890,7 +890,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/schedules/{scheduleId}/matching-times": {
"/namespaces/{namespace}/schedules/{scheduleId}/matching-times": {
"get": {
"summary": "Lists matching times within a range.",
"operationId": "ListScheduleMatchingTimes",
Expand Down Expand Up @@ -944,7 +944,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/schedules/{scheduleId}/patch": {
"/namespaces/{namespace}/schedules/{scheduleId}/patch": {
"post": {
"summary": "Makes a specific change to a schedule or triggers an immediate action.",
"operationId": "PatchSchedule",
Expand Down Expand Up @@ -991,7 +991,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/schedules/{scheduleId}/update": {
"/namespaces/{namespace}/schedules/{scheduleId}/update": {
"post": {
"summary": "Changes the configuration or state of an existing schedule.",
"operationId": "UpdateSchedule",
Expand Down Expand Up @@ -1038,7 +1038,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/search-attributes": {
"/namespaces/{namespace}/search-attributes": {
"get": {
"summary": "ListSearchAttributes returns comprehensive information about search attributes.",
"operationId": "ListSearchAttributes",
Expand Down Expand Up @@ -1069,7 +1069,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/task-queues/{taskQueue.name}": {
"/namespaces/{namespace}/task-queues/{taskQueue.name}": {
"get": {
"summary": "DescribeTaskQueue returns the following information about the target task queue, broken down by Build ID:\n - List of pollers\n - Workflow Reachability status\n - Backlog info for Workflow and/or Activity tasks",
"operationId": "DescribeTaskQueue",
Expand Down Expand Up @@ -1215,7 +1215,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/task-queues/{taskQueue}/worker-build-id-compatibility": {
"/namespaces/{namespace}/task-queues/{taskQueue}/worker-build-id-compatibility": {
"get": {
"summary": "Deprecated. Use `GetWorkerVersioningRules`.\nFetches the worker build id versioning sets for a task queue.",
"operationId": "GetWorkerBuildIdCompatibility",
Expand Down Expand Up @@ -1261,7 +1261,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/task-queues/{taskQueue}/worker-versioning-rules": {
"/namespaces/{namespace}/task-queues/{taskQueue}/worker-versioning-rules": {
"get": {
"summary": "Fetches the Build ID assignment and redirect rules for a Task Queue.\nWARNING: Worker Versioning is not yet stable and the API and behavior may change incompatibly.",
"operationId": "GetWorkerVersioningRules",
Expand Down Expand Up @@ -1298,7 +1298,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/update": {
"/namespaces/{namespace}/update": {
"post": {
"summary": "UpdateNamespace is used to update the information and configuration of a registered\nnamespace.",
"operationId": "UpdateNamespace",
Expand Down Expand Up @@ -1337,7 +1337,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/worker-task-reachability": {
"/namespaces/{namespace}/worker-task-reachability": {
"get": {
"summary": "Deprecated. Use `DescribeTaskQueue`.",
"description": "Fetches task reachability to determine whether a worker may be retired.\nThe request may specify task queues to query for or let the server fetch all task queues mapped to the given\nbuild IDs.\n\nWhen requesting a large number of task queues or all task queues associated with the given build ids in a\nnamespace, all task queues will be listed in the response but some of them may not contain reachability\ninformation due to a server enforced limit. When reaching the limit, task queues that reachability information\ncould not be retrieved for will be marked with a single TASK_REACHABILITY_UNSPECIFIED entry. The caller may issue\nanother call to get the reachability for those task queues.\n\nOpen source users can adjust this limit by setting the server's dynamic config value for\n`limit.reachabilityTaskQueueScan` with the caveat that this call can strain the visibility store.",
Expand Down Expand Up @@ -1406,7 +1406,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/workflow-count": {
"/namespaces/{namespace}/workflow-count": {
"get": {
"summary": "CountWorkflowExecutions is a visibility API to count of workflow executions in a specific namespace.",
"operationId": "CountWorkflowExecutions",
Expand Down Expand Up @@ -1443,7 +1443,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/workflows": {
"/namespaces/{namespace}/workflows": {
"get": {
"summary": "ListWorkflowExecutions is a visibility API to list workflow executions in a specific namespace.",
"operationId": "ListWorkflowExecutions",
Expand Down Expand Up @@ -1494,7 +1494,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/workflows/execute-multi-operation": {
"/namespaces/{namespace}/workflows/execute-multi-operation": {
"post": {
"summary": "ExecuteMultiOperation executes multiple operations within a single workflow.",
"description": "Operations are started atomically, meaning if *any* operation fails to be started, none are,\nand the request fails. Upon start, the API returns only when *all* operations have a response.\n\nUpon failure, it returns `MultiOperationExecutionFailure` where the status code\nequals the status code of the *first* operation that failed to be started.\n\nNOTE: Experimental API.",
Expand Down Expand Up @@ -1534,7 +1534,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}": {
"/namespaces/{namespace}/workflows/{execution.workflowId}": {
"get": {
"summary": "DescribeWorkflowExecution returns information about the specified workflow execution.",
"operationId": "DescribeWorkflowExecution",
Expand Down Expand Up @@ -1577,7 +1577,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}/history": {
"/namespaces/{namespace}/workflows/{execution.workflowId}/history": {
"get": {
"summary": "GetWorkflowExecutionHistory returns the history of specified workflow execution. Fails with\n`NotFound` if the specified workflow execution is unknown to the service.",
"operationId": "GetWorkflowExecutionHistory",
Expand Down Expand Up @@ -1661,7 +1661,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}/history-reverse": {
"/namespaces/{namespace}/workflows/{execution.workflowId}/history-reverse": {
"get": {
"summary": "GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse \norder (starting from last event). Fails with`NotFound` if the specified workflow execution is \nunknown to the service.",
"operationId": "GetWorkflowExecutionHistoryReverse",
Expand Down Expand Up @@ -1718,7 +1718,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}/query/{query.queryType}": {
"/namespaces/{namespace}/workflows/{execution.workflowId}/query/{query.queryType}": {
"post": {
"summary": "QueryWorkflow requests a query be executed for a specified workflow execution.",
"operationId": "QueryWorkflow",
Expand Down Expand Up @@ -1770,7 +1770,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/cancel": {
"/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/cancel": {
"post": {
"summary": "RequestCancelWorkflowExecution is called by workers when they want to request cancellation of\na workflow execution.",
"description": "This results in a new `WORKFLOW_EXECUTION_CANCEL_REQUESTED` event being written to the\nworkflow history and a new workflow task created for the workflow. It returns success if the requested\nworkflow is already closed. It fails with 'NotFound' if the requested workflow doesn't exist.",
Expand Down Expand Up @@ -1816,7 +1816,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/reset": {
"/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/reset": {
"post": {
"summary": "ResetWorkflowExecution will reset an existing workflow execution to a specified\n`WORKFLOW_TASK_COMPLETED` event (exclusive). It will immediately terminate the current\nexecution instance.\nTODO: Does exclusive here mean *just* the completed event, or also WFT started? Otherwise the task is doomed to time out?",
"operationId": "ResetWorkflowExecution",
Expand Down Expand Up @@ -1861,7 +1861,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/signal/{signalName}": {
"/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/signal/{signalName}": {
"post": {
"summary": "SignalWorkflowExecution is used to send a signal to a running workflow execution.",
"description": "This results in a `WORKFLOW_EXECUTION_SIGNALED` event recorded in the history and a workflow\ntask being created for the execution.",
Expand Down Expand Up @@ -1914,7 +1914,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/terminate": {
"/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/terminate": {
"post": {
"summary": "TerminateWorkflowExecution terminates an existing workflow execution by recording a\n`WORKFLOW_EXECUTION_TERMINATED` event in the history and immediately terminating the\nexecution instance.",
"operationId": "TerminateWorkflowExecution",
Expand Down Expand Up @@ -1959,7 +1959,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/update/{request.input.name}": {
"/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/update/{request.input.name}": {
"post": {
"summary": "Invokes the specified update function on user workflow code.",
"operationId": "UpdateWorkflowExecution",
Expand Down Expand Up @@ -2012,7 +2012,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/workflows/{workflowId}": {
"/namespaces/{namespace}/workflows/{workflowId}": {
"post": {
"summary": "StartWorkflowExecution starts a new workflow execution.",
"description": "It will create the execution with a `WORKFLOW_EXECUTION_STARTED` event in its history and\nalso schedule the first workflow task. Returns `WorkflowExecutionAlreadyStarted`, if an\ninstance already exists with same workflow id.",
Expand Down Expand Up @@ -2058,7 +2058,7 @@
]
}
},
"/api/v1/namespaces/{namespace}/workflows/{workflowId}/signal-with-start/{signalName}": {
"/namespaces/{namespace}/workflows/{workflowId}/signal-with-start/{signalName}": {
"post": {
"summary": "SignalWithStartWorkflowExecution is used to ensure a signal is sent to a workflow, even if\nit isn't yet started.",
"description": "If the workflow is running, a `WORKFLOW_EXECUTION_SIGNALED` event is recorded in the history\nand a workflow task is generated.\n\nIf the workflow is not running or not found, then the workflow is created with\n`WORKFLOW_EXECUTION_STARTED` and `WORKFLOW_EXECUTION_SIGNALED` events in its history, and a\nworkflow task is generated.",
Expand Down Expand Up @@ -2111,7 +2111,7 @@
]
}
},
"/api/v1/nexus/endpoints": {
"/nexus/endpoints": {
"get": {
"summary": "List all Nexus endpoints for the cluster, sorted by ID in ascending order. Set page_token in the request to the\nnext_page_token field of the previous response to get the next page of results. An empty next_page_token\nindicates that there are no more results. During pagination, a newly added service with an ID lexicographically\nearlier than the previous page's last endpoint's ID may be missed.",
"operationId": "ListNexusEndpoints",
Expand Down Expand Up @@ -2189,7 +2189,7 @@
]
}
},
"/api/v1/nexus/endpoints/{id}": {
"/nexus/endpoints/{id}": {
"get": {
"summary": "Get a registered Nexus endpoint by ID. The returned version can be used for optimistic updates.",
"operationId": "GetNexusEndpoint",
Expand Down Expand Up @@ -2259,7 +2259,7 @@
]
}
},
"/api/v1/nexus/endpoints/{id}/update": {
"/nexus/endpoints/{id}/update": {
"post": {
"summary": "Optimistically update a Nexus endpoint based on provided version as obtained via the `GetNexusEndpoint` or\n`ListNexusEndpointResponse` APIs. This will fail with a status of FAILED_PRECONDITION if the version does not\nmatch.\nReturns the updated endpoint with its updated version. You may use this version for subsequent updates. You don't\nneed to increment the version yourself. The server will increment the version for you after each update.",
"operationId": "UpdateNexusEndpoint",
Expand Down Expand Up @@ -2299,7 +2299,7 @@
]
}
},
"/api/v1/system-info": {
"/system-info": {
"get": {
"summary": "GetSystemInfo returns information about the system.",
"operationId": "GetSystemInfo",
Expand Down
Loading