Skip to content

Commit 7bd853b

Browse files
authored
ls-apis: mention related RFDs and sections (#8324)
The existing comments in `api-manifest.toml` were helpful, but I'd had a hard time determining the difference between "versioned_how", versioning mechanisms described in `openapi-manager`, and the words in RFD 532. Additionally, 532 and `api-manifeset.toml` talk about "updated before", and RFD 565 says more about the update sequence, so point to it as well.
1 parent aa42da5 commit 7bd853b

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

dev-tools/ls-apis/README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Crucible Pantry
9595
The `servers` and `deployment-units` commands accept a `--dot` argument to print output in a format that `dot(1)` can process:
9696

9797
```
98-
$ cargo xtask ls-apis deployment-units --dot > deployment-units.dot
98+
$ cargo xtask ls-apis deployment-units --output-format dot > deployment-units.dot
9999
```
100100

101101
You can generate a PNG image of the graph like this:

dev-tools/ls-apis/api-manifest.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,13 @@ packages = [ "oximeter-collector" ]
149149
# tooling supports this value so that during development you can
150150
# relax these constraints.
151151
#
152+
# "server" and "client" versioning is elaborated on more in RFD 532. Note that
153+
# "lockstep" collapses into "server" here, as it's trivially the case that if
154+
# the server and client(s) are updated atomically the server does not have to
155+
# support older clients. Additionally, the "updated before" relationship is
156+
# discussed some in RFD 565, [Update
157+
# sequence](https://rfd.shared.oxide.computer/rfd/0565#_update_sequence).
158+
#
152159
# [`versioned_how_reason`]: free text string explaining why `versioned_how` must
153160
# be "client" for this API. This is printed in documentation and command output
154161
# and serves as documentation for developers to understand why we made this

0 commit comments

Comments
 (0)