Skip to content

Commit ace0f71

Browse files
authored
Deprecate Seismic Planner Connector Operations (#3925)
1 parent 9533781 commit ace0f71

File tree

1 file changed

+96
-72
lines changed

1 file changed

+96
-72
lines changed

certified-connectors/Seismic Planner/apiDefinition.swagger.json

Lines changed: 96 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,11 @@
9090
"tags": [
9191
"Comment"
9292
],
93-
"description": "Get all comments for a given project, task, or request. Requires node (project, task, or request) ID.",
93+
"description": "Get all comments for a given project, task, or request. Requires node (project, task, or request) ID. (deprecated)",
9494
"operationId": "GetComments",
95-
"summary": "Get comments",
96-
"x-ms-summary": "Get comments"
95+
"deprecated": true,
96+
"summary": "Get comments (deprecated)",
97+
"x-ms-summary": "Get comments (deprecated)"
9798
},
9899
"post": {
99100
"consumes": [
@@ -145,10 +146,11 @@
145146
"tags": [
146147
"Comment"
147148
],
148-
"description": "Create a comment on a given project, task, or request. Requires node (project, task, or request) ID.",
149+
"description": "Create a comment on a given project, task, or request. Requires node (project, task, or request) ID. (deprecated)",
149150
"operationId": "CreateComment",
150-
"summary": "Create comment",
151-
"x-ms-summary": "Create comment"
151+
"deprecated": true,
152+
"summary": "Create comment (deprecated)",
153+
"x-ms-summary": "Create comment (deprecated)"
152154
}
153155
},
154156
"/planner/v2/spaces/{spaceId}/nodes/{nodeId}/comments/{commentId}": {
@@ -197,10 +199,11 @@
197199
"tags": [
198200
"Comment"
199201
],
200-
"description": "Get a single comment. Requires node (project, task, or request) and comment ID.",
202+
"description": "Get a single comment. Requires node (project, task, or request) and comment ID. (deprecated)",
201203
"operationId": "GetComment",
202-
"summary": "Get comment",
203-
"x-ms-summary": "Get comment"
204+
"deprecated": true,
205+
"summary": "Get comment (deprecated)",
206+
"x-ms-summary": "Get comment (deprecated)"
204207
},
205208
"delete": {
206209
"produces": [
@@ -244,10 +247,11 @@
244247
"tags": [
245248
"Comment"
246249
],
247-
"description": "Delete a comment. Requires node (project, task, or request) and comment ID.",
250+
"description": "Delete a comment. Requires node (project, task, or request) and comment ID. (deprecated)",
248251
"operationId": "DeleteComment",
249-
"summary": "Delete comment",
250-
"x-ms-summary": "Delete comment"
252+
"deprecated": true,
253+
"summary": "Delete comment (deprecated)",
254+
"x-ms-summary": "Delete comment (deprecated)"
251255
},
252256
"put": {
253257
"consumes": [
@@ -307,10 +311,11 @@
307311
"tags": [
308312
"Comment"
309313
],
310-
"description": "Update an existing comment. Requires node (project, task, or request) and comment ID.",
314+
"description": "Update an existing comment. Requires node (project, task, or request) and comment ID. (deprecated)",
311315
"operationId": "UpdateComment",
312-
"summary": "Update comment",
313-
"x-ms-summary": "Update comment"
316+
"deprecated": true,
317+
"summary": "Update comment (deprecated)",
318+
"x-ms-summary": "Update comment (deprecated)"
314319
}
315320
},
316321
"/planner/v2/spaces/{spaceId}/projects": {
@@ -470,10 +475,11 @@
470475
"tags": [
471476
"Project"
472477
],
473-
"description": "Get a list of projects with their attributes and associations.",
478+
"description": "Get a list of projects with their attributes and associations. (deprecated)",
474479
"operationId": "GetProjects",
475-
"summary": "Get projects",
476-
"x-ms-summary": "Get projects",
480+
"deprecated": true,
481+
"summary": "Get projects (deprecated)",
482+
"x-ms-summary": "Get projects (deprecated)",
477483
"x-seismic-scopes": [
478484
"seismic.planner.view",
479485
"seismic.planner.manage"
@@ -525,10 +531,11 @@
525531
"tags": [
526532
"Project"
527533
],
528-
"description": "Delete one or more projects.",
534+
"description": "Delete one or more projects. (deprecated)",
529535
"operationId": "DeleteProjects",
530-
"summary": "Delete projects",
531-
"x-ms-summary": "Delete projects",
536+
"deprecated": true,
537+
"summary": "Delete projects (deprecated)",
538+
"x-ms-summary": "Delete projects (deprecated)",
532539
"x-seismic-scopes": [
533540
"seismic.planner.manage"
534541
]
@@ -575,10 +582,11 @@
575582
"tags": [
576583
"Project"
577584
],
578-
"description": "Create a project.",
585+
"description": "Create a project. (deprecated)",
579586
"operationId": "CreateProject",
580-
"summary": "Create project",
581-
"x-ms-summary": "Create project",
587+
"deprecated": true,
588+
"summary": "Create project (deprecated)",
589+
"x-ms-summary": "Create project (deprecated)",
582590
"x-seismic-scopes": [
583591
"seismic.planner.manage"
584592
]
@@ -636,10 +644,11 @@
636644
"tags": [
637645
"Project"
638646
],
639-
"description": "Get a single project by ID. Return tasks if desired.",
647+
"description": "Get a single project by ID. Return tasks if desired. (deprecated)",
640648
"operationId": "GetProject",
641-
"summary": "Get project",
642-
"x-ms-summary": "Get project",
649+
"deprecated": true,
650+
"summary": "Get project (deprecated)",
651+
"x-ms-summary": "Get project (deprecated)",
643652
"x-seismic-scopes": [
644653
"seismic.planner.view",
645654
"seismic.planner.manage"
@@ -689,10 +698,11 @@
689698
"tags": [
690699
"Project"
691700
],
692-
"description": "Delete a project.",
701+
"description": "Delete a project. (deprecated)",
693702
"operationId": "DeleteProject",
694-
"summary": "Delete project",
695-
"x-ms-summary": "Delete project",
703+
"deprecated": true,
704+
"summary": "Delete project (deprecated)",
705+
"x-ms-summary": "Delete project (deprecated)",
696706
"x-seismic-scopes": [
697707
"seismic.planner.manage"
698708
]
@@ -747,10 +757,11 @@
747757
"tags": [
748758
"Project"
749759
],
750-
"description": "Update and return a project.",
760+
"description": "Update and return a project. (deprecated)",
751761
"operationId": "UpdateProject",
752-
"summary": "Update a project",
753-
"x-ms-summary": "Update a project"
762+
"deprecated": true,
763+
"summary": "Update a project (deprecated)",
764+
"x-ms-summary": "Update a project (deprecated)"
754765
}
755766
},
756767
"/planner/v2/spaces/{spaceId}/requests": {
@@ -1018,10 +1029,11 @@
10181029
"tags": [
10191030
"Request"
10201031
],
1021-
"description": "Get a list of requests.",
1032+
"description": "Get a list of requests. (deprecated)",
10221033
"operationId": "GetRequests",
1023-
"summary": "Get requests",
1024-
"x-ms-summary": "Get requests"
1034+
"deprecated": true,
1035+
"summary": "Get requests (deprecated)",
1036+
"x-ms-summary": "Get requests (deprecated)"
10251037
},
10261038
"delete": {
10271039
"consumes": [
@@ -1078,10 +1090,11 @@
10781090
"tags": [
10791091
"Request"
10801092
],
1081-
"description": "Bulk delete requests.",
1093+
"description": "Bulk delete requests. (deprecated)",
10821094
"operationId": "DeleteRequests",
1083-
"summary": "Delete requests",
1084-
"x-ms-summary": "Delete requests"
1095+
"deprecated": true,
1096+
"summary": "Delete requests (deprecated)",
1097+
"x-ms-summary": "Delete requests (deprecated)"
10851098
},
10861099
"post": {
10871100
"consumes": [
@@ -1125,10 +1138,11 @@
11251138
"tags": [
11261139
"Request"
11271140
],
1128-
"description": "Create a request.",
1141+
"description": "Create a request. (deprecated)",
11291142
"operationId": "CreateRequest",
1130-
"summary": "Create request",
1131-
"x-ms-summary": "Create request"
1143+
"deprecated": true,
1144+
"summary": "Create request (deprecated)",
1145+
"x-ms-summary": "Create request (deprecated)"
11321146
}
11331147
},
11341148
"/planner/v2/spaces/{spaceId}/requests/{requestId}": {
@@ -1168,10 +1182,11 @@
11681182
"tags": [
11691183
"Request"
11701184
],
1171-
"description": "Get a single request.",
1185+
"description": "Get a single request. (deprecated)",
11721186
"operationId": "GetRequest",
1173-
"summary": "Get request",
1174-
"x-ms-summary": "Get request"
1187+
"deprecated": true,
1188+
"summary": "Get request (deprecated)",
1189+
"x-ms-summary": "Get request (deprecated)"
11751190
},
11761191
"delete": {
11771192
"produces": [
@@ -1207,10 +1222,11 @@
12071222
"tags": [
12081223
"Request"
12091224
],
1210-
"description": "Delete a request.",
1225+
"description": "Delete a request. (deprecated)",
12111226
"operationId": "DeleteRequest",
1212-
"summary": "Delete request",
1213-
"x-ms-summary": "Delete request"
1227+
"deprecated": true,
1228+
"summary": "Delete request (deprecated)",
1229+
"x-ms-summary": "Delete request (deprecated)"
12141230
},
12151231
"put": {
12161232
"consumes": [
@@ -1263,10 +1279,11 @@
12631279
"tags": [
12641280
"Request"
12651281
],
1266-
"description": "Update a request.",
1282+
"description": "Update a request. (deprecated)",
12671283
"operationId": "UpdateRequest",
1268-
"summary": "Update request",
1269-
"x-ms-summary": "Update request"
1284+
"deprecated": true,
1285+
"summary": "Update request (deprecated)",
1286+
"x-ms-summary": "Update request (deprecated)"
12701287
}
12711288
},
12721289
"/planner/v2/spaces/{spaceId}/statusschema": {
@@ -1350,10 +1367,11 @@
13501367
"tags": [
13511368
"Status Schema"
13521369
],
1353-
"description": "Get a list of task/request status schemas. These schemas hold the data for set statuses for specific work.\n\nExample: `(Not started, In progress, Complete)`",
1370+
"description": "Get a list of task/request status schemas. These schemas hold the data for set statuses for specific work.\n\nExample: `(Not started, In progress, Complete)` (deprecated)",
13541371
"operationId": "GetStatusSchemas",
1355-
"summary": "Get status schemas",
1356-
"x-ms-summary": "Get status schemas"
1372+
"deprecated": true,
1373+
"summary": "Get status schemas (deprecated)",
1374+
"x-ms-summary": "Get status schemas (deprecated)"
13571375
}
13581376
},
13591377
"/planner/v2/spaces/{spaceId}/statusschema/{statusSchemaId}": {
@@ -1393,10 +1411,11 @@
13931411
"tags": [
13941412
"Status Schema"
13951413
],
1396-
"description": "Get a single status schema by ID. These schemas hold the data for set statuses for specific work.\n\nExample: `(Not started, In progress, Complete)`",
1414+
"description": "Get a single status schema by ID. These schemas hold the data for set statuses for specific work.\n\nExample: `(Not started, In progress, Complete)` (deprecated)",
13971415
"operationId": "GetStatusSchema",
1398-
"summary": "Get status schema",
1399-
"x-ms-summary": "Get status schema"
1416+
"deprecated": true,
1417+
"summary": "Get status schema (deprecated)",
1418+
"x-ms-summary": "Get status schema (deprecated)"
14001419
}
14011420
},
14021421
"/planner/v2/spaces/{spaceId}/tasks": {
@@ -1674,10 +1693,11 @@
16741693
"tags": [
16751694
"Task"
16761695
],
1677-
"description": "Get a list of tasks.",
1696+
"description": "Get a list of tasks. (deprecated)",
16781697
"operationId": "GetTasks",
1679-
"summary": "Get tasks",
1680-
"x-ms-summary": "Get tasks"
1698+
"deprecated": true,
1699+
"summary": "Get tasks (deprecated)",
1700+
"x-ms-summary": "Get tasks (deprecated)"
16811701
},
16821702
"post": {
16831703
"consumes": [
@@ -1721,10 +1741,11 @@
17211741
"tags": [
17221742
"Task"
17231743
],
1724-
"description": "Create a task.",
1744+
"description": "Create a task. (deprecated)",
17251745
"operationId": "CreateTask",
1726-
"summary": "Create task",
1727-
"x-ms-summary": "Create task"
1746+
"deprecated": true,
1747+
"summary": "Create task (deprecated)",
1748+
"x-ms-summary": "Create task (deprecated)"
17281749
}
17291750
},
17301751
"/planner/v2/spaces/{spaceId}/tasks/{taskId}": {
@@ -1764,10 +1785,11 @@
17641785
"tags": [
17651786
"Task"
17661787
],
1767-
"description": "Get a single task by ID.",
1788+
"description": "Get a single task by ID. (deprecated)",
17681789
"operationId": "GetTask",
1769-
"summary": "Get task",
1770-
"x-ms-summary": "Get task"
1790+
"deprecated": true,
1791+
"summary": "Get task (deprecated)",
1792+
"x-ms-summary": "Get task (deprecated)"
17711793
},
17721794
"delete": {
17731795
"produces": [
@@ -1805,10 +1827,11 @@
18051827
"tags": [
18061828
"Task"
18071829
],
1808-
"description": "Delete a task.",
1830+
"description": "Delete a task. (deprecated)",
18091831
"operationId": "DeleteTask",
1810-
"summary": "Delete task",
1811-
"x-ms-summary": "Delete task",
1832+
"deprecated": true,
1833+
"summary": "Delete task (deprecated)",
1834+
"x-ms-summary": "Delete task (deprecated)",
18121835
"x-seismic-scopes": [
18131836
"seismic.planner.manage"
18141837
]
@@ -1864,10 +1887,11 @@
18641887
"tags": [
18651888
"Task"
18661889
],
1867-
"description": "Update an existing task.",
1890+
"description": "Update an existing task. (deprecated)",
18681891
"operationId": "UpdateTask",
1869-
"summary": "Update task",
1870-
"x-ms-summary": "Update task"
1892+
"deprecated": true,
1893+
"summary": "Update task (deprecated)",
1894+
"x-ms-summary": "Update task (deprecated)"
18711895
}
18721896
}
18731897
},

0 commit comments

Comments
 (0)