Skip to content

Commit 2fb68c1

Browse files
gal-revachgal-revach
authored
Update deprecated API.md
1 parent 7b503b8 commit 2fb68c1

File tree

1 file changed

+50
-11
lines changed

1 file changed

+50
-11
lines changed

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

Lines changed: 50 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -128,30 +128,69 @@ 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-
The following list of API endpoints have been marked for deprecation:
131+
The following list of API endpoints and fields that have been marked for deprecation:
132132

133-
#### Jobs, events, pods API (replaced by workloads/pods/events)
133+
#### Jobs and Pods API
134134

135-
| Deprecated endpoint | Replacement endpoint |
135+
| Deprecated | Replacement |
136136
| -- | -- |
137137
| https://app.run.ai/v1/k8s/clusters/{uuid}/jobs | https://app.run.ai/api/v1/workloads |
138138
| https://app.run.ai/v1/k8s/clusters/{uuid}/jobs/count | https://app.run.ai/api/v1/workloads/count |
139139
| https://app.run.ai/v1/k8s/clusters/{uuid}/jobs/{jobId}/pods | https://app.run.ai/api/v1/workloads/{workloadId}/pods |
140140
| https://app.run.ai/v1/k8s/clusters/{uuid}/pods | https://app.run.ai/api/v1/workloads/pods |
141141

142-
#### Users, Applications, and Groups API
142+
#### Clusters API
143+
| Deprecated | Replacement |
144+
| -- | -- |
145+
| https://app.run.ai/v1/k8s/clusters | https://app.run.ai/api/v1/workloads |
146+
| https://app.run.ai/v1/k8s/clusters/{uuid} | https://app.run.ai/api/v1/workloads/count |
147+
| https://app.run.ai/v1/k8s/clusters/{clusterUuid}/metrics | https://app.run.ai/api/v1/clusters/{clusterUuid}/metrics |
148+
149+
#### Authorization and Authentication API
150+
151+
| Deprecated | Replacement |
152+
| -- | -- |
153+
| https://app.run.ai/v1/k8s/auth/token/exchange | https://app.run.ai/api/v1/token |
154+
| https://app.run.ai/v1/k8s/auth/oauth/tokens/refresh | https://app.run.ai/api/v1/token |
155+
| https://app.run.ai/v1/k8s/auth/oauth/apptoken | https://app.run.ai/api/v1/token |
156+
| https://app.run.ai/v1/k8s/users/roles | https://app.run.ai/api/v1/authorization/roles |
157+
| https://app.run.ai/v1/k8s/users | https://app.run.ai/api/v1/users |
158+
| https://app.run.ai/v1/k8s/users/{userId} | https://app.run.ai/api/v1/users/{userId} |
159+
| https://app.run.ai/v1/k8s/users/{userId}/roles | https://app.run.ai/api/v1/authorization/access-rules |
160+
| https://app.run.ai/v1/k8s/apps | https://app.run.ai/api/v1/apps |
161+
| https://app.run.ai/v1/k8s/apps/{clientId} | https://app.run.ai/api/v1/apps/{appId} |
162+
| https://app.run.ai/v1/k8s/groups | https://app.run.ai/api/v1/authorization/access-rules |
163+
| https://app.run.ai/v1/k8s/groups/{groupName} | https://app.run.ai/api/v1/authorization/access-rules |
164+
| https://app.run.ai/v1/k8s/clusters/{clusterId}/departments/{department-id}/access-control | https://app.run.ai/api/v1/authorization/access-rules |
165+
| https://app.run.ai/api/v1/authorization/access-rules - _subjectIdFilter_ field | Use _filterBy_ / _sortBy_ fields |
166+
| https://app.run.ai/api/v1/authorization/access-rules - _scopeType_ field | Use _filterBy_ / _sortBy_ fields |
167+
| https://app.run.ai/api/v1/authorization/access-rules - _roleId_ field | Use _filterBy_ / _sortBy_ fields |
168+
169+
#### Projects API
170+
171+
| Deprecated | Replacement |
172+
| -- | -- |
173+
| https://app.run.ai/v1/k8s/clusters/{clusterId}/projects - _permissions_ field | https://app.run.ai/api/v1/authorization/access-rules |
174+
| https://app.run.ai/v1/k8s/clusters/{clusterId}/projects - _resources_ field | Use _nodePoolResources_ field |
175+
| https://app.run.ai/v1/k8s/clusters/{clusterId}/projects - _deservedGpus_ field | Use _nodePoolResources_ field |
176+
| https://app.run.ai/v1/k8s/clusters/{clusterId}/projects - _maxAllowedGpus_ field | Use _nodePoolResources_ field |
177+
| https://app.run.ai/v1/k8s/clusters/{clusterId}/projects - _gpuOverQuotaWeight_ field | Use _nodePoolResources_ field |
178+
179+
#### Departments API
143180

144-
| Deprecated endpoint | Replacement endpoint |
181+
| Deprecated | Replacement |
145182
| -- | -- |
146-
| https://app.run.ai/v1/k8s/apps | https://app.run.ai/api/v1/k8s/apps |
147-
| https://app.run.ai/v1/k8s/users | https://app.run.ai/api/v1/k8s/users |
148-
| https://app.run.ai/v1/k8s/groups | https://app.run.ai/api/v1/authorization/access-rules (groups should no longer be created, you can only add access rules to them) |
183+
| https://app.run.ai/v1/k8s/clusters/{clusterId}/projects - _resources_ field | Use _nodePoolResources_ field |
184+
| https://app.run.ai/v1/k8s/clusters/{clusterId}/projects - _deservedGpus_ field | Use _nodePoolResources_ field |
185+
| https://app.run.ai/v1/k8s/clusters/{clusterId}/projects - _allowOverQuota_ field | Use _nodePoolResources_ field |
186+
| https://app.run.ai/v1/k8s/clusters/{clusterId}/projects - _maxAllowedGpus_ field | Use _nodePoolResources_ field |
149187

150-
#### Cluster metrics v1 (replaced by v2)
188+
#### Policy API
151189

152-
| Deprecated endpoint | Replacement endpoint |
190+
| Deprecated | Replacement |
153191
| -- | -- |
154-
| https://app.run.ai/v1/k8s/clusters/{clusterUuid}/metrics | https://app.run.ai/api/v2/clusters/{clusterUuid}/metrics |
192+
| https://app.run.ai/api/v1/policy/workspace | https://app.run.ai/api/v2/policy/workspaces |
193+
| https://app.run.ai/api/v1/policy/training | https://app.run.ai/api/v2/policy/trainings |
155194

156195
## Breaking changes
157196

0 commit comments

Comments
 (0)