Skip to content

Commit 74f9631

Browse files
cretzcretz
authored
Removed /api/v1 prefix for HTTP paths (#410)
Fixes #409
1 parent ed75617 commit 74f9631

File tree

4 files changed

+138
-138
lines changed

4 files changed

+138
-138
lines changed

‎openapi/openapiv2.json

+44-44
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"application/json"
2020
],
2121
"paths": {
22-
"/api/v1/cluster-info": {
22+
"/cluster-info": {
2323
"get": {
2424
"summary": "GetClusterInfo returns information about temporal cluster",
2525
"operationId": "GetClusterInfo",
@@ -42,7 +42,7 @@
4242
]
4343
}
4444
},
45-
"/api/v1/namespaces": {
45+
"/namespaces": {
4646
"get": {
4747
"summary": "ListNamespaces returns the information and configuration for all namespaces.",
4848
"operationId": "ListNamespaces",
@@ -120,7 +120,7 @@
120120
]
121121
}
122122
},
123-
"/api/v1/namespaces/{namespace}": {
123+
"/namespaces/{namespace}": {
124124
"get": {
125125
"summary": "DescribeNamespace returns the information and configuration for a registered namespace.",
126126
"operationId": "DescribeNamespace",
@@ -157,7 +157,7 @@
157157
]
158158
}
159159
},
160-
"/api/v1/namespaces/{namespace}/activities/cancel": {
160+
"/namespaces/{namespace}/activities/cancel": {
161161
"post": {
162162
"summary": "RespondActivityTaskFailed is called by workers when processing an activity task fails.",
163163
"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.",
@@ -197,7 +197,7 @@
197197
]
198198
}
199199
},
200-
"/api/v1/namespaces/{namespace}/activities/cancel-by-id": {
200+
"/namespaces/{namespace}/activities/cancel-by-id": {
201201
"post": {
202202
"summary": "See `RecordActivityTaskCanceled`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
203203
"operationId": "RespondActivityTaskCanceledById",
@@ -237,7 +237,7 @@
237237
]
238238
}
239239
},
240-
"/api/v1/namespaces/{namespace}/activities/complete": {
240+
"/namespaces/{namespace}/activities/complete": {
241241
"post": {
242242
"summary": "RespondActivityTaskCompleted is called by workers when they successfully complete an activity\ntask.",
243243
"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.",
@@ -277,7 +277,7 @@
277277
]
278278
}
279279
},
280-
"/api/v1/namespaces/{namespace}/activities/complete-by-id": {
280+
"/namespaces/{namespace}/activities/complete-by-id": {
281281
"post": {
282282
"summary": "See `RecordActivityTaskCompleted`. This version allows clients to record completions by\nnamespace/workflow id/activity id instead of task token.",
283283
"operationId": "RespondActivityTaskCompletedById",
@@ -317,7 +317,7 @@
317317
]
318318
}
319319
},
320-
"/api/v1/namespaces/{namespace}/activities/fail": {
320+
"/namespaces/{namespace}/activities/fail": {
321321
"post": {
322322
"summary": "RespondActivityTaskFailed is called by workers when processing an activity task fails.",
323323
"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.",
@@ -357,7 +357,7 @@
357357
]
358358
}
359359
},
360-
"/api/v1/namespaces/{namespace}/activities/fail-by-id": {
360+
"/namespaces/{namespace}/activities/fail-by-id": {
361361
"post": {
362362
"summary": "See `RecordActivityTaskFailed`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
363363
"operationId": "RespondActivityTaskFailedById",
@@ -397,7 +397,7 @@
397397
]
398398
}
399399
},
400-
"/api/v1/namespaces/{namespace}/activities/heartbeat": {
400+
"/namespaces/{namespace}/activities/heartbeat": {
401401
"post": {
402402
"summary": "RecordActivityTaskHeartbeat is optionally called by workers while they execute activities.",
403403
"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.",
@@ -437,7 +437,7 @@
437437
]
438438
}
439439
},
440-
"/api/v1/namespaces/{namespace}/activities/heartbeat-by-id": {
440+
"/namespaces/{namespace}/activities/heartbeat-by-id": {
441441
"post": {
442442
"summary": "See `RecordActivityTaskHeartbeat`. This version allows clients to record heartbeats by\nnamespace/workflow id/activity id instead of task token.",
443443
"operationId": "RecordActivityTaskHeartbeatById",
@@ -477,7 +477,7 @@
477477
]
478478
}
479479
},
480-
"/api/v1/namespaces/{namespace}/archived-workflows": {
480+
"/namespaces/{namespace}/archived-workflows": {
481481
"get": {
482482
"summary": "ListArchivedWorkflowExecutions is a visibility API to list archived workflow executions in a specific namespace.",
483483
"operationId": "ListArchivedWorkflowExecutions",
@@ -528,7 +528,7 @@
528528
]
529529
}
530530
},
531-
"/api/v1/namespaces/{namespace}/batch-operations": {
531+
"/namespaces/{namespace}/batch-operations": {
532532
"get": {
533533
"summary": "ListBatchOperations returns a list of batch operations",
534534
"operationId": "ListBatchOperations",
@@ -576,7 +576,7 @@
576576
]
577577
}
578578
},
579-
"/api/v1/namespaces/{namespace}/batch-operations/{jobId}": {
579+
"/namespaces/{namespace}/batch-operations/{jobId}": {
580580
"get": {
581581
"summary": "DescribeBatchOperation returns the information about a batch operation",
582582
"operationId": "DescribeBatchOperation",
@@ -660,7 +660,7 @@
660660
]
661661
}
662662
},
663-
"/api/v1/namespaces/{namespace}/batch-operations/{jobId}/stop": {
663+
"/namespaces/{namespace}/batch-operations/{jobId}/stop": {
664664
"post": {
665665
"summary": "StopBatchOperation stops a batch operation",
666666
"operationId": "StopBatchOperation",
@@ -707,7 +707,7 @@
707707
]
708708
}
709709
},
710-
"/api/v1/namespaces/{namespace}/schedules": {
710+
"/namespaces/{namespace}/schedules": {
711711
"get": {
712712
"summary": "List all schedules in a namespace.",
713713
"operationId": "ListSchedules",
@@ -762,7 +762,7 @@
762762
]
763763
}
764764
},
765-
"/api/v1/namespaces/{namespace}/schedules/{scheduleId}": {
765+
"/namespaces/{namespace}/schedules/{scheduleId}": {
766766
"get": {
767767
"summary": "Returns the schedule description and current state of an existing schedule.",
768768
"operationId": "DescribeSchedule",
@@ -890,7 +890,7 @@
890890
]
891891
}
892892
},
893-
"/api/v1/namespaces/{namespace}/schedules/{scheduleId}/matching-times": {
893+
"/namespaces/{namespace}/schedules/{scheduleId}/matching-times": {
894894
"get": {
895895
"summary": "Lists matching times within a range.",
896896
"operationId": "ListScheduleMatchingTimes",
@@ -944,7 +944,7 @@
944944
]
945945
}
946946
},
947-
"/api/v1/namespaces/{namespace}/schedules/{scheduleId}/patch": {
947+
"/namespaces/{namespace}/schedules/{scheduleId}/patch": {
948948
"post": {
949949
"summary": "Makes a specific change to a schedule or triggers an immediate action.",
950950
"operationId": "PatchSchedule",
@@ -991,7 +991,7 @@
991991
]
992992
}
993993
},
994-
"/api/v1/namespaces/{namespace}/schedules/{scheduleId}/update": {
994+
"/namespaces/{namespace}/schedules/{scheduleId}/update": {
995995
"post": {
996996
"summary": "Changes the configuration or state of an existing schedule.",
997997
"operationId": "UpdateSchedule",
@@ -1038,7 +1038,7 @@
10381038
]
10391039
}
10401040
},
1041-
"/api/v1/namespaces/{namespace}/search-attributes": {
1041+
"/namespaces/{namespace}/search-attributes": {
10421042
"get": {
10431043
"summary": "ListSearchAttributes returns comprehensive information about search attributes.",
10441044
"operationId": "ListSearchAttributes",
@@ -1069,7 +1069,7 @@
10691069
]
10701070
}
10711071
},
1072-
"/api/v1/namespaces/{namespace}/task-queues/{taskQueue.name}": {
1072+
"/namespaces/{namespace}/task-queues/{taskQueue.name}": {
10731073
"get": {
10741074
"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",
10751075
"operationId": "DescribeTaskQueue",
@@ -1215,7 +1215,7 @@
12151215
]
12161216
}
12171217
},
1218-
"/api/v1/namespaces/{namespace}/task-queues/{taskQueue}/worker-build-id-compatibility": {
1218+
"/namespaces/{namespace}/task-queues/{taskQueue}/worker-build-id-compatibility": {
12191219
"get": {
12201220
"summary": "Deprecated. Use `GetWorkerVersioningRules`.\nFetches the worker build id versioning sets for a task queue.",
12211221
"operationId": "GetWorkerBuildIdCompatibility",
@@ -1261,7 +1261,7 @@
12611261
]
12621262
}
12631263
},
1264-
"/api/v1/namespaces/{namespace}/task-queues/{taskQueue}/worker-versioning-rules": {
1264+
"/namespaces/{namespace}/task-queues/{taskQueue}/worker-versioning-rules": {
12651265
"get": {
12661266
"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.",
12671267
"operationId": "GetWorkerVersioningRules",
@@ -1298,7 +1298,7 @@
12981298
]
12991299
}
13001300
},
1301-
"/api/v1/namespaces/{namespace}/update": {
1301+
"/namespaces/{namespace}/update": {
13021302
"post": {
13031303
"summary": "UpdateNamespace is used to update the information and configuration of a registered\nnamespace.",
13041304
"operationId": "UpdateNamespace",
@@ -1337,7 +1337,7 @@
13371337
]
13381338
}
13391339
},
1340-
"/api/v1/namespaces/{namespace}/worker-task-reachability": {
1340+
"/namespaces/{namespace}/worker-task-reachability": {
13411341
"get": {
13421342
"summary": "Deprecated. Use `DescribeTaskQueue`.",
13431343
"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.",
@@ -1406,7 +1406,7 @@
14061406
]
14071407
}
14081408
},
1409-
"/api/v1/namespaces/{namespace}/workflow-count": {
1409+
"/namespaces/{namespace}/workflow-count": {
14101410
"get": {
14111411
"summary": "CountWorkflowExecutions is a visibility API to count of workflow executions in a specific namespace.",
14121412
"operationId": "CountWorkflowExecutions",
@@ -1443,7 +1443,7 @@
14431443
]
14441444
}
14451445
},
1446-
"/api/v1/namespaces/{namespace}/workflows": {
1446+
"/namespaces/{namespace}/workflows": {
14471447
"get": {
14481448
"summary": "ListWorkflowExecutions is a visibility API to list workflow executions in a specific namespace.",
14491449
"operationId": "ListWorkflowExecutions",
@@ -1494,7 +1494,7 @@
14941494
]
14951495
}
14961496
},
1497-
"/api/v1/namespaces/{namespace}/workflows/execute-multi-operation": {
1497+
"/namespaces/{namespace}/workflows/execute-multi-operation": {
14981498
"post": {
14991499
"summary": "ExecuteMultiOperation executes multiple operations within a single workflow.",
15001500
"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.",
@@ -1534,7 +1534,7 @@
15341534
]
15351535
}
15361536
},
1537-
"/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}": {
1537+
"/namespaces/{namespace}/workflows/{execution.workflowId}": {
15381538
"get": {
15391539
"summary": "DescribeWorkflowExecution returns information about the specified workflow execution.",
15401540
"operationId": "DescribeWorkflowExecution",
@@ -1577,7 +1577,7 @@
15771577
]
15781578
}
15791579
},
1580-
"/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}/history": {
1580+
"/namespaces/{namespace}/workflows/{execution.workflowId}/history": {
15811581
"get": {
15821582
"summary": "GetWorkflowExecutionHistory returns the history of specified workflow execution. Fails with\n`NotFound` if the specified workflow execution is unknown to the service.",
15831583
"operationId": "GetWorkflowExecutionHistory",
@@ -1661,7 +1661,7 @@
16611661
]
16621662
}
16631663
},
1664-
"/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}/history-reverse": {
1664+
"/namespaces/{namespace}/workflows/{execution.workflowId}/history-reverse": {
16651665
"get": {
16661666
"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.",
16671667
"operationId": "GetWorkflowExecutionHistoryReverse",
@@ -1718,7 +1718,7 @@
17181718
]
17191719
}
17201720
},
1721-
"/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}/query/{query.queryType}": {
1721+
"/namespaces/{namespace}/workflows/{execution.workflowId}/query/{query.queryType}": {
17221722
"post": {
17231723
"summary": "QueryWorkflow requests a query be executed for a specified workflow execution.",
17241724
"operationId": "QueryWorkflow",
@@ -1770,7 +1770,7 @@
17701770
]
17711771
}
17721772
},
1773-
"/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/cancel": {
1773+
"/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/cancel": {
17741774
"post": {
17751775
"summary": "RequestCancelWorkflowExecution is called by workers when they want to request cancellation of\na workflow execution.",
17761776
"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.",
@@ -1816,7 +1816,7 @@
18161816
]
18171817
}
18181818
},
1819-
"/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/reset": {
1819+
"/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/reset": {
18201820
"post": {
18211821
"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?",
18221822
"operationId": "ResetWorkflowExecution",
@@ -1861,7 +1861,7 @@
18611861
]
18621862
}
18631863
},
1864-
"/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/signal/{signalName}": {
1864+
"/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/signal/{signalName}": {
18651865
"post": {
18661866
"summary": "SignalWorkflowExecution is used to send a signal to a running workflow execution.",
18671867
"description": "This results in a `WORKFLOW_EXECUTION_SIGNALED` event recorded in the history and a workflow\ntask being created for the execution.",
@@ -1914,7 +1914,7 @@
19141914
]
19151915
}
19161916
},
1917-
"/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/terminate": {
1917+
"/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/terminate": {
19181918
"post": {
19191919
"summary": "TerminateWorkflowExecution terminates an existing workflow execution by recording a\n`WORKFLOW_EXECUTION_TERMINATED` event in the history and immediately terminating the\nexecution instance.",
19201920
"operationId": "TerminateWorkflowExecution",
@@ -1959,7 +1959,7 @@
19591959
]
19601960
}
19611961
},
1962-
"/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/update/{request.input.name}": {
1962+
"/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/update/{request.input.name}": {
19631963
"post": {
19641964
"summary": "Invokes the specified update function on user workflow code.",
19651965
"operationId": "UpdateWorkflowExecution",
@@ -2012,7 +2012,7 @@
20122012
]
20132013
}
20142014
},
2015-
"/api/v1/namespaces/{namespace}/workflows/{workflowId}": {
2015+
"/namespaces/{namespace}/workflows/{workflowId}": {
20162016
"post": {
20172017
"summary": "StartWorkflowExecution starts a new workflow execution.",
20182018
"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.",
@@ -2058,7 +2058,7 @@
20582058
]
20592059
}
20602060
},
2061-
"/api/v1/namespaces/{namespace}/workflows/{workflowId}/signal-with-start/{signalName}": {
2061+
"/namespaces/{namespace}/workflows/{workflowId}/signal-with-start/{signalName}": {
20622062
"post": {
20632063
"summary": "SignalWithStartWorkflowExecution is used to ensure a signal is sent to a workflow, even if\nit isn't yet started.",
20642064
"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.",
@@ -2111,7 +2111,7 @@
21112111
]
21122112
}
21132113
},
2114-
"/api/v1/nexus/endpoints": {
2114+
"/nexus/endpoints": {
21152115
"get": {
21162116
"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.",
21172117
"operationId": "ListNexusEndpoints",
@@ -2189,7 +2189,7 @@
21892189
]
21902190
}
21912191
},
2192-
"/api/v1/nexus/endpoints/{id}": {
2192+
"/nexus/endpoints/{id}": {
21932193
"get": {
21942194
"summary": "Get a registered Nexus endpoint by ID. The returned version can be used for optimistic updates.",
21952195
"operationId": "GetNexusEndpoint",
@@ -2259,7 +2259,7 @@
22592259
]
22602260
}
22612261
},
2262-
"/api/v1/nexus/endpoints/{id}/update": {
2262+
"/nexus/endpoints/{id}/update": {
22632263
"post": {
22642264
"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.",
22652265
"operationId": "UpdateNexusEndpoint",
@@ -2299,7 +2299,7 @@
22992299
]
23002300
}
23012301
},
2302-
"/api/v1/system-info": {
2302+
"/system-info": {
23032303
"get": {
23042304
"summary": "GetSystemInfo returns information about the system.",
23052305
"operationId": "GetSystemInfo",

0 commit comments

Comments
 (0)