Repository navigation
Conversation
Every workspace-level call on /ai_gw/v2 requires workspace_id as a UUID,
but nothing in the specification said where a caller gets one. The
Workspace Service is that place: list, create, get and update workspaces,
each with its UUID `id`.
- /workspaces and /workspaces/{id} under the `Workspaces` tag, from
engineering's Workspace Service API 1.0.0 specification
- a fifth plane, `workspace`, for its own host:
https://api.sase.paloaltonetworks.com/airs/workspace/v1
- components prefixed `Workspace…`; the source's `Error` collided with
ours, and `Limit` / `NotFound` read as global in a shared document
- the inherited Workspaces and Workspaces > Members drops removed from
drops.yaml, and their mentions from the README
- README counts: 133 paths, 207 operations, 47 tags, 6 hosts
Descriptions stay empty like everywhere else: they go through the
overlay once a KB claim supports them.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Why
Customers calling the Admin API with an SCM service-account token have to pass
workspace_id, and it must be the workspace's UUID. Strata Cloud Manager shows the slug, not the UUID, so today the only way to get one is to copy it out of the console URL. The Workspace Service API is the supported way to look it up, and this PR adds it to the reference.What
Workspacestag, 4 operations from engineering's Workspace Service API 1.0.0 spec:GET /workspaces: list, withlimit/offset, andname(substring) orexact_namefiltersPOST /workspaces: create, bound to an existing SCM scope viascope_nameGET /workspaces/{id}PUT /workspaces/{id}: replacesnameanddescriptionworkspacein_project/servers.yamland_project/planes.yaml, athttps://api.sase.paloaltonetworks.com/airs/workspace/v1. Same bearer token.Workspace…. The source'sErrorcollided with an existing schema, and names likeLimitandNotFoundwould read as global here.drops.yaml: the inheritedWorkspacesandWorkspaces > Membersentries are gone. The README no longer mentions them./aigw/api-reference/workspaces/.Descriptions are empty, the same as every other operation. They come in through
overlays/docs-prose.yamlonce a KB claim backs them. A KB entry for this has been submitted.Checks
build.py --checkandcheck.pypasslint.py: no new findings. The only failure is the existingpath-paramson/api-keys/{sub-type}(OAS-16), which is already on main.Follow-up
The docs-core PR links to the new pages, so merge this one first.
🤖 Generated with Claude Code