Skip to content

Commit c197cca

Browse files
authored
API docs: remove trailing periods from operation summaries (#9636)
1 parent ec9b6cc commit c197cca

5 files changed

Lines changed: 29680 additions & 34 deletions

File tree

Cargo.lock

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

nexus/external-api/src/lib.rs

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ api_versions!([
7070
// | date-based version should be at the top of the list.
7171
// v
7272
// (next_yyyymmddnn, IDENT),
73+
(2026011300, DOC_LINT_SUMMARY_TRAILING_PERIOD),
7374
(2026011100, MULTICAST_JOIN_LEAVE_DOCS),
7475
(2026010800, MULTICAST_IMPLICIT_LIFECYCLE_UPDATES),
7576
(2026010500, POOL_SELECTION_ENUMS),
@@ -469,7 +470,7 @@ pub trait NexusExternalApi {
469470
query_params: Query<PaginatedByNameOrId>,
470471
) -> Result<HttpResponseOk<ResultsPage<views::Silo>>, HttpError>;
471472

472-
/// Create a silo
473+
/// Create silo
473474
#[endpoint {
474475
method = POST,
475476
path = "/v1/system/silos",
@@ -536,7 +537,7 @@ pub trait NexusExternalApi {
536537
query_params: Query<PaginatedByNameOrId>,
537538
) -> Result<HttpResponseOk<ResultsPage<views::SiloIpPool>>, HttpError>;
538539

539-
/// Delete a silo
540+
/// Delete silo
540541
///
541542
/// Delete a silo by name or ID.
542543
#[endpoint {
@@ -938,7 +939,7 @@ pub trait NexusExternalApi {
938939
// problem? (HTTP may require that this be idempotent.) If so, can we get
939940
// around that having this be a slightly different content-type (e.g.,
940941
// "application/json-patch")? We should see what other APIs do.
941-
/// Update a project
942+
/// Update project
942943
#[endpoint {
943944
method = PUT,
944945
path = "/v1/projects/{project}",
@@ -1199,7 +1200,7 @@ pub trait NexusExternalApi {
11991200
query_params: Query<IpPoolRangePaginationParams>,
12001201
) -> Result<HttpResponseOk<ResultsPage<views::IpPoolRange>>, HttpError>;
12011202

1202-
/// Add range to IP pool.
1203+
/// Add range to an IP pool
12031204
///
12041205
/// IPv6 ranges are not allowed yet for unicast pools.
12051206
///
@@ -1405,7 +1406,7 @@ pub trait NexusExternalApi {
14051406
// TODO: Consider adding `.map()` to dropshot's `Path<T>` (like `TypedBody`)
14061407
// to enable inline delegation when path types differ between API versions.
14071408

1408-
/// List multicast groups.
1409+
/// List multicast groups
14091410
#[endpoint {
14101411
method = GET,
14111412
path = "/v1/multicast-groups",
@@ -1429,7 +1430,7 @@ pub trait NexusExternalApi {
14291430
}
14301431
}
14311432

1432-
/// List multicast groups.
1433+
/// List multicast groups
14331434
#[endpoint {
14341435
method = GET,
14351436
path = "/v1/multicast-groups",
@@ -1441,7 +1442,7 @@ pub trait NexusExternalApi {
14411442
query_params: Query<PaginatedByNameOrId>,
14421443
) -> Result<HttpResponseOk<ResultsPage<views::MulticastGroup>>, HttpError>;
14431444

1444-
/// Create a multicast group.
1445+
/// Create a multicast group
14451446
///
14461447
/// Deprecated: Groups are created implicitly when adding members in newer
14471448
/// API versions.
@@ -1466,7 +1467,7 @@ pub trait NexusExternalApi {
14661467
))
14671468
}
14681469

1469-
/// Fetch a multicast group.
1470+
/// Fetch a multicast group
14701471
///
14711472
/// The group can be specified by name or UUID.
14721473
#[endpoint {
@@ -1483,7 +1484,7 @@ pub trait NexusExternalApi {
14831484
path_params: Path<v2025121200::MulticastGroupPath>,
14841485
) -> Result<HttpResponseOk<v2025121200::MulticastGroup>, HttpError>;
14851486

1486-
/// Fetch a multicast group.
1487+
/// Fetch multicast group
14871488
///
14881489
/// The group can be specified by name, UUID, or multicast IP address.
14891490
/// (e.g., "224.1.2.3" or "ff38::1").
@@ -1498,7 +1499,7 @@ pub trait NexusExternalApi {
14981499
path_params: Path<params::MulticastGroupPath>,
14991500
) -> Result<HttpResponseOk<views::MulticastGroup>, HttpError>;
15001501

1501-
/// Update a multicast group.
1502+
/// Update a multicast group
15021503
///
15031504
/// Deprecated: groups are managed implicitly through member operations.
15041505
#[endpoint {
@@ -1521,7 +1522,7 @@ pub trait NexusExternalApi {
15211522
))
15221523
}
15231524

1524-
/// Delete a multicast group.
1525+
/// Delete multicast group
15251526
///
15261527
/// Deprecated: groups are deleted automatically when the last member leaves.
15271528
#[endpoint {
@@ -1543,7 +1544,7 @@ pub trait NexusExternalApi {
15431544
))
15441545
}
15451546

1546-
/// List members of a multicast group.
1547+
/// List members of multicast group
15471548
///
15481549
/// The group can be specified by name or UUID.
15491550
#[endpoint {
@@ -1564,7 +1565,7 @@ pub trait NexusExternalApi {
15641565
HttpError,
15651566
>;
15661567

1567-
/// List members of a multicast group.
1568+
/// List members of multicast group
15681569
///
15691570
/// The group can be specified by name, UUID, or multicast IP address.
15701571
#[endpoint {
@@ -1579,7 +1580,7 @@ pub trait NexusExternalApi {
15791580
query_params: Query<PaginatedById>,
15801581
) -> Result<HttpResponseOk<ResultsPage<MulticastGroupMember>>, HttpError>;
15811582

1582-
/// Add instance to a multicast group.
1583+
/// Add instance to multicast group
15831584
///
15841585
/// Deprecated: use the instance join endpoint which supports implicit group
15851586
/// creation and accepts group by name, UUID, or IP address.
@@ -1606,7 +1607,7 @@ pub trait NexusExternalApi {
16061607
))
16071608
}
16081609

1609-
/// Remove instance from a multicast group.
1610+
/// Remove instance from multicast group
16101611
///
16111612
/// Deprecated: use the instance leave endpoint which accepts group by name,
16121613
/// UUID, or IP address.
@@ -1631,7 +1632,7 @@ pub trait NexusExternalApi {
16311632
))
16321633
}
16331634

1634-
/// Look up multicast group by IP address.
1635+
/// Look up multicast group by IP address
16351636
///
16361637
/// Deprecated: use the main view endpoint which accepts IP addresses directly.
16371638
#[endpoint {
@@ -1715,7 +1716,7 @@ pub trait NexusExternalApi {
17151716
}
17161717

17171718
// TODO-correctness See note about instance create. This should be async.
1718-
/// Create a disk
1719+
/// Create disk
17191720
#[endpoint {
17201721
method = POST,
17211722
path = "/v1/disks",
@@ -2007,7 +2008,7 @@ pub trait NexusExternalApi {
20072008
instance_config: TypedBody<params::InstanceUpdate>,
20082009
) -> Result<HttpResponseOk<Instance>, HttpError>;
20092010

2010-
/// Reboot an instance
2011+
/// Reboot instance
20112012
#[endpoint {
20122013
method = POST,
20132014
path = "/v1/instances/{instance}/reboot",
@@ -2929,7 +2930,7 @@ pub trait NexusExternalApi {
29292930
path_params: Path<params::BgpAnnounceSetSelector>,
29302931
) -> Result<HttpResponseOk<Vec<BgpAnnouncement>>, HttpError>;
29312932

2932-
/// Enable a BFD session
2933+
/// Enable BFD session
29332934
#[endpoint {
29342935
method = POST,
29352936
path = "/v1/system/networking/bfd-enable",
@@ -2940,7 +2941,7 @@ pub trait NexusExternalApi {
29402941
session: TypedBody<params::BfdSessionEnable>,
29412942
) -> Result<HttpResponseUpdatedNoContent, HttpError>;
29422943

2943-
/// Disable a BFD session
2944+
/// Disable BFD session
29442945
#[endpoint {
29452946
method = POST,
29462947
path = "/v1/system/networking/bfd-disable",
@@ -3353,7 +3354,7 @@ pub trait NexusExternalApi {
33533354

33543355
// Instance Multicast Groups
33553356

3356-
/// List multicast groups for an instance.
3357+
/// List multicast groups for an instance
33573358
#[endpoint {
33583359
method = GET,
33593360
path = "/v1/instances/{instance}/multicast-groups",
@@ -3387,7 +3388,7 @@ pub trait NexusExternalApi {
33873388
}
33883389
}
33893390

3390-
/// List multicast groups for an instance.
3391+
/// List multicast groups for an instance
33913392
#[endpoint {
33923393
method = GET,
33933394
path = "/v1/instances/{instance}/multicast-groups",
@@ -3403,7 +3404,7 @@ pub trait NexusExternalApi {
34033404
HttpError,
34043405
>;
34053406

3406-
/// Join a multicast group.
3407+
/// Join multicast group
34073408
///
34083409
/// Deprecated: newer version supports implicit group creation, accepts group
34093410
/// by name/UUID/IP and allows specifying source IPs (optional for ASM,
@@ -3421,7 +3422,7 @@ pub trait NexusExternalApi {
34213422
query_params: Query<params::OptionalProjectSelector>,
34223423
) -> Result<HttpResponseCreated<v2025121200::MulticastGroupMember>, HttpError>;
34233424

3424-
/// Join a multicast group by name, IP address, or UUID.
3425+
/// Join multicast group by name, IP address, or UUID
34253426
///
34263427
/// Groups can be referenced by name, IP address, or UUID. If the group
34273428
/// doesn't exist, it's implicitly created with an auto-allocated IP from a
@@ -3444,7 +3445,7 @@ pub trait NexusExternalApi {
34443445
body_params: TypedBody<params::InstanceMulticastGroupJoin>,
34453446
) -> Result<HttpResponseCreated<views::MulticastGroupMember>, HttpError>;
34463447

3447-
/// Leave a multicast group.
3448+
/// Leave multicast group
34483449
///
34493450
/// Deprecated: newer version accepts group by name, UUID, or IP address.
34503451
#[endpoint {
@@ -3462,7 +3463,7 @@ pub trait NexusExternalApi {
34623463
query_params: Query<params::OptionalProjectSelector>,
34633464
) -> Result<HttpResponseDeleted, HttpError>;
34643465

3465-
/// Leave a multicast group by name, IP address, or UUID.
3466+
/// Leave multicast group by name, IP address, or UUID
34663467
#[endpoint {
34673468
method = DELETE,
34683469
path = "/v1/instances/{instance}/multicast-groups/{multicast_group}",
@@ -3563,7 +3564,7 @@ pub trait NexusExternalApi {
35633564
query_params: Query<params::OptionalProjectSelector>,
35643565
) -> Result<HttpResponseOk<views::Vpc>, HttpError>;
35653566

3566-
/// Update a VPC
3567+
/// Update VPC
35673568
#[endpoint {
35683569
method = PUT,
35693570
path = "/v1/vpcs/{vpc}",
@@ -4104,7 +4105,7 @@ pub trait NexusExternalApi {
41044105
query_params: Query<PaginatedById>,
41054106
) -> Result<HttpResponseOk<ResultsPage<views::PhysicalDisk>>, HttpError>;
41064107

4107-
/// Get a physical disk
4108+
/// Get physical disk
41084109
#[endpoint {
41094110
method = GET,
41104111
path = "/v1/system/hardware/disks/{disk_id}",
@@ -4593,7 +4594,7 @@ pub trait NexusExternalApi {
45934594
query_params: Query<PaginatedByTimeAndId>,
45944595
) -> Result<HttpResponseOk<ResultsPage<shared::SupportBundleInfo>>, HttpError>;
45954596

4596-
/// View a support bundle
4597+
/// View support bundle
45974598
#[endpoint {
45984599
method = GET,
45994600
path = "/experimental/v1/system/support-bundles/{bundle_id}",

0 commit comments

Comments
 (0)