refactor: use American English, and follow the renamed contract - #140
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. To trigger a review, include ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Align the OpenAPI source with the generated client and change the remaining unrecognised spellings.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 1
Open (1)
What changed in this PR
This PR standardizes American English across the CLI and updates the vendored Serverless contract, generated client, and documentation.
Changes:
- Renames contract identifiers and the path-normalization helper.
- Updates CLI text, comments, tests, and generated documentation.
- Regenerates the Serverless client and command docs.
| File | Summary |
|---|---|
internal/schema/schema.go |
Schema terminology and helper updates; unrecognised remains. |
internal/schema/schema_test.go |
Test wording updates; matching spelling remains. |
internal/output/print.go |
Serialization terminology updates. |
internal/output/output.go |
Format documentation updates. |
internal/http/download_test.go |
Cancellation wording updates. |
internal/cmdutil/mediainput_test.go |
Comment terminology updates. |
internal/cmdutil/completion.go |
Normalization documentation updates. |
internal/cmd/serverless/usage.go |
Usage terminology updates. |
internal/cmd/serverless/secrets.go |
Secrets help terminology updates. |
internal/cmd/serverless/pack.go |
Artifact terminology updates. |
internal/cmd/serverless/pack_test.go |
Normalization comment updates. |
internal/cmd/serverless/gpus.go |
Catalog terminology updates. |
internal/cmd/serverless/env.go |
Help terminology updates. |
internal/cmd/serverless/display.go |
Display comment updates. |
internal/cmd/serverless/deploy.go |
Deployment help terminology updates. |
internal/cmd/serverless/apps_logs.go |
Cancellation comment updates. |
internal/cmd/serverless/apps_lifecycle.go |
Cancellation error wording updates. |
internal/cmd/run/run.go |
Behavior comment updates. |
internal/cmd/run/output.go |
Serialization comment updates. |
internal/api/types.go |
API behavior comment updates. |
internal/api/transport/websocket.go |
Transport and cancellation comment updates. |
internal/api/transport/websocket_test.go |
Test comment updates. |
internal/api/transport/transport.go |
Recognition terminology updates. |
internal/api/serverless/usage.go |
Serverless API terminology updates. |
internal/api/serverless/secrets.go |
Serverless API terminology updates. |
internal/api/serverless/gen/client.gen.go |
Regenerated client; generated spelling can drift from the OpenAPI source. |
internal/api/serverless/client.go |
API comment updates. |
internal/api/schema_test.go |
Cancellation terminology updates. |
internal/api/poll_test.go |
Behavior comment updates. |
internal/api/client.go |
Cancellation comment updates. |
docs/runware_serverless.md |
Regenerated command documentation. |
docs/runware_serverless_usage.md |
Regenerated usage documentation. |
docs/runware_serverless_secrets.md |
Regenerated secrets documentation. |
docs/runware_serverless_secrets_set.md |
Regenerated secrets documentation. |
docs/runware_serverless_secrets_remove.md |
Regenerated secrets documentation. |
docs/runware_serverless_secrets_list.md |
Regenerated secrets documentation. |
docs/runware_serverless_secrets_detach.md |
Regenerated secrets documentation. |
docs/runware_serverless_secrets_attachments.md |
Regenerated attachments documentation. |
docs/runware_serverless_secrets_attach.md |
Regenerated attachment documentation. |
docs/runware_serverless_deploy.md |
Regenerated deployment documentation. |
docs/runware_serverless_apps_usage.md |
Regenerated application usage documentation. |
docs/runware_serverless_apps_env.md |
Regenerated environment documentation. |
cmd/runware/main.go |
Cancellation comment updates. |
api/serverless/openapi.yaml |
Contract updates; remaining cancelled strings need alignment before regeneration. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Pairs with serverless#607, which renames six identifiers on the public contract. Merge this after that one.
The contract half
All 79 references the CLI had to the old names were in its vendored
api/serverless/openapi.yamland the client generated from it. No hand-written command code names them, so this is the spelling change applied to that copy plusmake generate-serverless.The rest of the vendored spec is deliberately left stale. Copying serverless
mainwholesale pulls in the error-status changes from #593 and breaksApplicationproblemJSON403handling ininternal/api/serverless/client.go, which is a spec sync somebody should do on purpose rather than inside a spelling PR.The CLI's own half
Help text, output strings, comments and
README.md. One internal rename,normalisePathSegments.cancelledhere is prose about Go contexts and one error message, never a value read off the API, so it becomescanceled. The storedcredit_auto_top_up_statevalue in serverless is untouched for the opposite reason.go build ./...andgo test ./...pass, andmake docsis regenerated.