Skip to content

Commit 61bac27

Browse files
authored
Update API deprecations.md
1 parent 2fb68c1 commit 61bac27

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

docs/home/whats-new-2-17.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,11 @@ Deprecated features will be available for **two** versions ahead of the notifica
128128

129129
The endpoints and parameters specified in the API reference are the ones that are officially supported by Run:ai. For more information about Run:ai's API support policy and deprecation process, see [Developer overview](../developer/overview-developer.md#overview-developer-documentation).
130130

131+
#### Deprecated APIs and API fields
132+
131133
The following list of API endpoints and fields that have been marked for deprecation:
132134

133-
#### Jobs and Pods API
135+
##### Jobs and Pods API
134136

135137
| Deprecated | Replacement |
136138
| -- | -- |
@@ -139,14 +141,14 @@ The following list of API endpoints and fields that have been marked for depreca
139141
| https://app.run.ai/v1/k8s/clusters/{uuid}/jobs/{jobId}/pods | https://app.run.ai/api/v1/workloads/{workloadId}/pods |
140142
| https://app.run.ai/v1/k8s/clusters/{uuid}/pods | https://app.run.ai/api/v1/workloads/pods |
141143

142-
#### Clusters API
144+
##### Clusters API
143145
| Deprecated | Replacement |
144146
| -- | -- |
145147
| https://app.run.ai/v1/k8s/clusters | https://app.run.ai/api/v1/workloads |
146148
| https://app.run.ai/v1/k8s/clusters/{uuid} | https://app.run.ai/api/v1/workloads/count |
147149
| https://app.run.ai/v1/k8s/clusters/{clusterUuid}/metrics | https://app.run.ai/api/v1/clusters/{clusterUuid}/metrics |
148150

149-
#### Authorization and Authentication API
151+
##### Authorization and Authentication API
150152

151153
| Deprecated | Replacement |
152154
| -- | -- |
@@ -166,7 +168,7 @@ The following list of API endpoints and fields that have been marked for depreca
166168
| https://app.run.ai/api/v1/authorization/access-rules - _scopeType_ field | Use _filterBy_ / _sortBy_ fields |
167169
| https://app.run.ai/api/v1/authorization/access-rules - _roleId_ field | Use _filterBy_ / _sortBy_ fields |
168170

169-
#### Projects API
171+
##### Projects API
170172

171173
| Deprecated | Replacement |
172174
| -- | -- |
@@ -176,7 +178,7 @@ The following list of API endpoints and fields that have been marked for depreca
176178
| https://app.run.ai/v1/k8s/clusters/{clusterId}/projects - _maxAllowedGpus_ field | Use _nodePoolResources_ field |
177179
| https://app.run.ai/v1/k8s/clusters/{clusterId}/projects - _gpuOverQuotaWeight_ field | Use _nodePoolResources_ field |
178180

179-
#### Departments API
181+
##### Departments API
180182

181183
| Deprecated | Replacement |
182184
| -- | -- |
@@ -185,13 +187,23 @@ The following list of API endpoints and fields that have been marked for depreca
185187
| https://app.run.ai/v1/k8s/clusters/{clusterId}/projects - _allowOverQuota_ field | Use _nodePoolResources_ field |
186188
| https://app.run.ai/v1/k8s/clusters/{clusterId}/projects - _maxAllowedGpus_ field | Use _nodePoolResources_ field |
187189

188-
#### Policy API
190+
##### Policy API
189191

190192
| Deprecated | Replacement |
191193
| -- | -- |
192194
| https://app.run.ai/api/v1/policy/workspace | https://app.run.ai/api/v2/policy/workspaces |
193195
| https://app.run.ai/api/v1/policy/training | https://app.run.ai/api/v2/policy/trainings |
194196

197+
#### Removed APIs and API fields (completed deprecation)
198+
199+
The following list of API endpoints and fields that have completed their deprecation process and therefore will be changed as follows:
200+
201+
##### Assets API
202+
203+
| Endpoint | Change |
204+
| -- | -- |
205+
| https://app.run.ai/api/v1/asset/compute | |
206+
195207
## Breaking changes
196208

197209
Breaking changes notifications allow you to plan around potential changes that may interfere your current workflow when interfacing with the Run:ai Platform.

0 commit comments

Comments
 (0)