Skip to content

Commit f5a505e

Browse files
authored
Merge pull request #912 from run-ai/rename-admin-api
control-plane-api
2 parents c72e541 + 732e2da commit f5a505e

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

docs/developer/admin-rest-api/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ For example, if you have an Administrator role, you can get a list of clusters b
4343

4444
For an additional example, see the [following](https://github.com/run-ai/docs/blob/master/examples/create-user-and-project.py){target=_blank} code. It is an example of how to use the Run:ai Administrator REST API to create a User and a Project and set the User to the Project.
4545

46-
## Administrator API Documentation
46+
## Control Plane API Documentation
4747

48-
The Administrator API provides the developer interfaces for getting and manipulating the Run:ai metadata objects such as Projects, Departments, Clusters, and Users.
48+
The Control Plane API provides the developer interfaces for getting and manipulating the Run:ai metadata objects such as Projects, Departments, Clusters, and Users.
4949

5050
Detailed API documentation can be found at [https://app.run.ai/api/docs](https://app.run.ai/api/docs){target=_blank}. This represents the latest control-plane documentation. If you are running a self-hosted version, see `https://<runai-company-url>/api/docs`.
5151

52-
[Administrator API Documentation](https://app.run.ai/api/docs){target=_blank .md-button .md-button--primary }
52+
[Control Plane API Documentation](https://app.run.ai/api/docs){target=_blank .md-button .md-button--primary }

docs/developer/overview-developer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,19 @@ Run:ai is composed of a single, multi-tenant control plane. Each tenant can be c
2222

2323
Below is a diagram of the Run:ai API Architecture. A developer may:
2424

25-
1. Access the control plane via the _Administrator API_.
25+
1. Access the control plane via the _Control Plane API_.
2626
2. Access any one of the GPU clusters via _Cluster API_.
2727
3. Access cluster metrics via the _Metrics API_.
2828

2929
![api architecture image](img/api-architecture.png)
3030

31-
## Administrator API
31+
## Control Plane API
3232

3333
Add, delete, modify and list Run:ai meta-data objects such as Projects, Departments, Users, and more.
3434

3535
The API is provided as REST and is accessible via the control plane endpoint.
3636

37-
For more information see [Administrator REST API](admin-rest-api/overview.md).
37+
For more information see [Control Plane REST API](admin-rest-api/overview.md).
3838

3939
## Cluster API
4040

docs/developer/rest-auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,4 +79,4 @@ The API response will look as follows:
7979
To call APIs, the application must pass the retrieved `accessToken` as a *Bearer token* in the Authorization header of your HTTP request.
8080

8181
* To retrieve and manipulate Workloads, use the [Cluster API](cluster-api/workload-overview-dev.md). Researcher API works at the cluster level and you will have different endpoints for different clusters.
82-
* To retrieve and manipulate other metadata objects, use the [Administrator REST API](admin-rest-api/overview.md). Administrator API works at the control-plane level and you have a single endpoint for all clusters.
82+
* To retrieve and manipulate other metadata objects, use the [Control Plane REST API](admin-rest-api/overview.md). Control Plane API works at the control-plane level and you have a single endpoint for all clusters.

0 commit comments

Comments
 (0)