Skip to content

Add some missing endpoint deprecations #2384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 17, 2023
Merged

Add some missing endpoint deprecations #2384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17c8162
add some missing deprecations
david-crespo Feb 17, 2023
2d55e08
missed one
david-crespo Feb 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion nexus/src/external_api/http_entrypoints.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2788,10 +2788,12 @@ async fn instance_list_v1(
}

/// List instances
/// Use `GET /v1/instances` instead
#[endpoint {
method = GET,
path = "/organizations/{organization_name}/projects/{project_name}/instances",
tags = ["instances"],
deprecated = true,
}]
async fn instance_list(
rqctx: RequestContext<Arc<ServerContext>>,
Expand Down Expand Up @@ -2967,10 +2969,12 @@ async fn instance_view(
}

/// Fetch an instance by id
/// Use `GET /v1/instances/{instance}` instead
#[endpoint {
method = GET,
path = "/by-id/instances/{id}",
tags = ["instances"],
deprecated = true,
}]
async fn instance_view_by_id(
rqctx: RequestContext<Arc<ServerContext>>,
Expand Down Expand Up @@ -4239,10 +4243,12 @@ async fn instance_network_interface_list_v1(
apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
}
/// List network interfaces
/// Use `GET /v1/network-interfaces` instead
#[endpoint {
method = GET,
path = "/organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/network-interfaces",
tags = ["instances"],
deprecated = true,
}]
async fn instance_network_interface_list(
rqctx: RequestContext<Arc<ServerContext>>,
Expand Down Expand Up @@ -4395,10 +4401,13 @@ async fn instance_network_interface_delete_v1(
/// are any secondary interfaces. A new primary interface must be designated
/// first. The primary interface can be deleted if there are no secondary
/// interfaces.
///
/// Use `DELETE /v1/network-interfaces/{interface}` instead
#[endpoint {
method = DELETE,
path = "/organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/network-interfaces/{interface_name}",
tags = ["instances"],
deprecated = true,
}]
async fn instance_network_interface_delete(
rqctx: RequestContext<Arc<ServerContext>>,
Expand Down Expand Up @@ -4486,10 +4495,13 @@ async fn instance_network_interface_view(
}

/// Fetch a network interface by id
///
/// Use `GET /v1/network-interfaces/{interface}` instead
#[endpoint {
method = GET,
path = "/by-id/network-interfaces/{id}",
tags = ["instances"],
deprecated = true,
}]
async fn instance_network_interface_view_by_id(
rqctx: RequestContext<Arc<ServerContext>>,
Expand Down Expand Up @@ -5882,10 +5894,12 @@ async fn vpc_router_view(
}

/// Get a router by id
/// Use `GET /v1/vpc-routers/{router}` instead
#[endpoint {
method = GET,
path = "/by-id/vpc-routers/{id}",
tags = ["vpcs"],
deprecated = true,
}]
async fn vpc_router_view_by_id(
rqctx: RequestContext<Arc<ServerContext>>,
Expand Down Expand Up @@ -6106,7 +6120,7 @@ async fn vpc_router_update(
apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
}

// List routes
/// List routes
///
/// List the routes associated with a router in a particular VPC.
#[endpoint {
Expand Down
24 changes: 18 additions & 6 deletions openapi/nexus.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@
"instances"
],
"summary": "Fetch an instance by id",
"description": "Use `GET /v1/instances/{instance}` instead",
"operationId": "instance_view_by_id",
"parameters": [
{
Expand Down Expand Up @@ -123,7 +124,8 @@
"5XX": {
"$ref": "#/components/responses/Error"
}
}
},
"deprecated": true
}
},
"/by-id/network-interfaces/{id}": {
Expand All @@ -132,6 +134,7 @@
"instances"
],
"summary": "Fetch a network interface by id",
"description": "Use `GET /v1/network-interfaces/{interface}` instead",
"operationId": "instance_network_interface_view_by_id",
"parameters": [
{
Expand Down Expand Up @@ -161,7 +164,8 @@
"5XX": {
"$ref": "#/components/responses/Error"
}
}
},
"deprecated": true
}
},
"/by-id/organizations/{id}": {
Expand Down Expand Up @@ -330,6 +334,7 @@
"vpcs"
],
"summary": "Get a router by id",
"description": "Use `GET /v1/vpc-routers/{router}` instead",
"operationId": "vpc_router_view_by_id",
"parameters": [
{
Expand Down Expand Up @@ -359,7 +364,8 @@
"5XX": {
"$ref": "#/components/responses/Error"
}
}
},
"deprecated": true
}
},
"/by-id/vpc-subnets/{id}": {
Expand Down Expand Up @@ -1929,6 +1935,7 @@
"instances"
],
"summary": "List instances",
"description": "Use `GET /v1/instances` instead",
"operationId": "instance_list",
"parameters": [
{
Expand Down Expand Up @@ -1995,6 +2002,7 @@
"$ref": "#/components/responses/Error"
}
},
"deprecated": true,
"x-dropshot-pagination": true
},
"post": {
Expand Down Expand Up @@ -2492,6 +2500,7 @@
"instances"
],
"summary": "List network interfaces",
"description": "Use `GET /v1/network-interfaces` instead",
"operationId": "instance_network_interface_list",
"parameters": [
{
Expand Down Expand Up @@ -2564,6 +2573,7 @@
"$ref": "#/components/responses/Error"
}
},
"deprecated": true,
"x-dropshot-pagination": true
},
"post": {
Expand Down Expand Up @@ -2768,7 +2778,7 @@
"instances"
],
"summary": "Delete a network interface",
"description": "Note that the primary interface for an instance cannot be deleted if there are any secondary interfaces. A new primary interface must be designated first. The primary interface can be deleted if there are no secondary interfaces.",
"description": "Note that the primary interface for an instance cannot be deleted if there are any secondary interfaces. A new primary interface must be designated first. The primary interface can be deleted if there are no secondary interfaces.\nUse `DELETE /v1/network-interfaces/{interface}` instead",
"operationId": "instance_network_interface_delete",
"parameters": [
{
Expand Down Expand Up @@ -2814,7 +2824,8 @@
"5XX": {
"$ref": "#/components/responses/Error"
}
}
},
"deprecated": true
}
},
"/organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/reboot": {
Expand Down Expand Up @@ -10986,7 +10997,8 @@
"tags": [
"vpcs"
],
"summary": "List the routes associated with a router in a particular VPC.",
"summary": "List routes",
"description": "List the routes associated with a router in a particular VPC.",
"operationId": "vpc_router_route_list_v1",
"parameters": [
{
Expand Down