docs(cloud): document projects as the canonical Management API resource - #135
Merged
lukekim merged 1 commit intoAug 1, 2026
Merged
Conversation
lukekim
approved these changes
Aug 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The Management API resource previously called an app is now called a project.
/v1/projectsis the canonical path and/v1/appsremains served as a permanently supported legacy alias, marked deprecated in the published OpenAPI specification. The Management API pages still documented only the legacy paths.This updates the two hand-written Management API pages to the canonical paths and adds a section explaining the relationship, including the two details that actually break a naive migration:
GET /v1/projectsreturns results under aprojectskey;GET /v1/appskeeps its originalappskey. Everything else — response shapes, field names — is identical.apps:read,apps:write, andapps:delete, because they are embedded in already-issued tokens. The scope table now describes them in project terms while keeping the literal names, and a note says so explicitly.The Spice CLI, Terraform provider, and SDKs continue to call the legacy paths, so the page states they are unaffected.
Pages updated
cloud/api/management/README.md— new Projects and apps section and an intro hint; canonical paths in all curl examples; scope descriptions and rate-limit wording updated; endpoint list labels renamed.cloud/api/management/dedicated-clusters.md— canonicalPOST /v1/projectsandPUT /v1/projects/{projectId}, and project terminology throughout.Verification
api.spice.ai/openapi.jsonlists all seven/v1/projects*paths, carries all seven/v1/apps*paths withdeprecated: true, and its own description states the rename. UnauthenticatedGET /v1/projectsreturns401(route exists and reaches the auth layer) while a nonexistent path returns404.projectsvsapps) read directly from the published spec's 200 response schemas, not inferred.#projects-and-appsandREADME.md#create-a-deploymentanchors both match real headings. No new pages, so noSUMMARY.mdchange.{% hint %}syntax used, not:::admonitions.Deliberately out of scope
cloud/api/management/README.md(../../../portal/profile/personal-access-tokens.md, which needs../../, and../../../support/support.md). Both are already ontrunkand both are covered by the open sitewide link-repair PR fix(docs): repair broken and cross-space docs links sitewide #127, which touches this same file — left alone to avoid a conflict.cloud/portal/still say "Apps", matching neither the portal UI nor this page. That is a much larger editorial sweep across many pages plus navigation entries and deep links, and it deserves its own PR rather than riding along here. The new section is written so a reader landing on either term is not confused in the meantime.The generated Management API reference under Management APIs comes from the GitBook OpenAPI block, so its endpoint list tracks the published spec automatically and needed no edit.