Skip to content

update entrypoint naming doc comment #1363

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
Jul 7, 2022
Merged

update entrypoint naming doc comment #1363

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4a962f
update entrypoint naming doc comment
ahl Jul 6, 2022
5f9e7cc
Update nexus/src/external_api/http_entrypoints.rs
ahl Jul 6, 2022
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
31 changes: 16 additions & 15 deletions nexus/src/external_api/http_entrypoints.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,25 +253,26 @@ pub fn external_api() -> NexusApiDescription {
// DELETE /organizations/{org_name} (delete a organization in the collection)
// PUT /organizations/{org_name} (update a organization in the collection)
//
// There's a naming convention for the functions that implement these API entry
// points. When operating on the collection itself, we use:
// We pick a name for the function that implements a given API entrypoint
// based on how we expect it to appear in the CLI subcommand hierarchy. For
// example:
//
// {collection_path}_{verb}
// GET /organizations -> organization_list()
// POST /organizations -> organization_create()
// GET /organizations/{org_name} -> organization_view()
// DELETE /organizations/{org_name} -> organization_delete()
// PUT /organizations/{org_name} -> organization_update()
//
// For examples:
// Note that the path typically uses the entity's plural form while the
// function name uses its singular.
//
// GET /organizations -> organizations_get()
// POST /organizations -> organizations_post()
// Operations beyond list, create, view, delete, and update should use a
// descriptive noun or verb, again bearing in mind that this will be
// transcribed into the CLI and SDKs:
//
// For operations on items within the collection, we use:
//
// {collection_path}_{verb}_{object}
//
// For examples:
//
// DELETE /organizations/{org_name} -> organizations_delete_organization()
// GET /organizations/{org_name} -> organizations_get_organization()
// PUT /organizations/{org_name} -> organizations_put_organization()
// POST -> instance_reboot
// POST -> instance_stop
// GET -> instance_serial_console
//
// Note that these function names end up in generated OpenAPI spec as the
// operationId for each endpoint, and therefore represent a contract with
Expand Down