docs: CUB-4728 document private cubes and lineage stubs in the Metadata API - #12008
Draft
MikeNitsenko wants to merge 2 commits into
Draft
MikeNitsenko wants to merge 2 commits into
MikeNitsenko wants to merge 2 commits into
Conversation
…ta API Metadata API entities and members now report `public`, and private cubes or members that public members reference are returned as lineage stubs so every reference resolves. Document the `public` field, what a stub contains, the 404 case, and how data access policies limit stubbing. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0173XoBwpEFcgJPe6ehxBDrA
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
github-actions
Bot
added
docs
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0173XoBwpEFcgJPe6ehxBDrA
This branch was successfully deployed
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
2 participants
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.
Check List
Issue Reference this PR resolves
CUB-4728. Documents the Metadata API behaviour from cubedevinc/cube-runtime#1162.
Description of Changes Made
Updates the Metadata API section of the REST (JSON) API reference (
docs-mintlify/reference/core-data-apis/rest-api/reference.mdx):/v1/entities: list items now includepublic, and the list includes private cubes returned as lineage stubs. Example updated./v1/entities/{name}and/v1/entities/all: newpublicfield on entities and members.sqlandis_primary_keyare noted as omitted on stubs. Examples updated.publicis reported on stub cubes and stub members404for a private cube that no public member referencespublicto keep only public entitiesThe stub example was checked against the output of the builder on cubedevinc/cube-runtime#1162.
Merge timing: this describes behaviour that ships with cubedevinc/cube-runtime#1162. It's a draft until that change is released to Cube Cloud, so the docs don't run ahead of the product.
🤖 Generated with Claude Code
https://claude.ai/code/session_0173XoBwpEFcgJPe6ehxBDrA
Generated by Claude Code