Skip to content

[PLAT-8912] Document property key policies - #111

Merged
MadisonEhlers-Vertex merged 7 commits into
mainfrom
codex/plat-8912
Aug 3, 2026
Merged

MadisonEhlers-Vertex merged 7 commits into
mainfrom
codex/plat-8912

Conversation

@MadisonEhlers-Vertex

@MadisonEhlers-Vertex MadisonEhlers-Vertex commented Jul 30, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Add a developer guide for property key policy allowlists and denylists.
  • Document the PR #766 /keys API contract for creating policies, adding keys, and binding a policy to a scene stream key.
  • Add the guide to API Advanced Steps navigation.

Validation

  • Docusaurus production build succeeds.
  • Platdev acceptance test: created an allowlist policy, added and retrieved the part-number and material keys, confirmed idempotent upsert, and created a stream key that returned the selected propertyKeyPolicyId.
  • Deleted the temporary stream key and policy after verification.

@MadisonEhlers-Vertex MadisonEhlers-Vertex changed the title Document property key policies [PLAT-8912] Document property key policies Jul 30, 2026
@MadisonEhlers-Vertex
MadisonEhlers-Vertex marked this pull request as ready for review July 30, 2026 18:01
@MadisonEhlers-Vertex
MadisonEhlers-Vertex requested a review from a team as a code owner July 30, 2026 18:01
Comment thread docs/guides/property-key-policies.mdx Outdated
Comment thread docs/guides/property-key-policies.mdx
Comment thread docs/guides/property-key-policies.mdx
@sksizer

sksizer commented Jul 30, 2026

Copy link
Copy Markdown

This may be pedantic - but just an FYI this is the one entry in the left hand navigation that requires two lines. maybe we throw in a style to indent the second line or something:

image

sksizer
sksizer previously approved these changes Jul 30, 2026

@sksizer sksizer left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple minor nits/questions but no blockers

@MadisonEhlers-Vertex

MadisonEhlers-Vertex commented Jul 30, 2026 •

Copy link
Copy Markdown
Contributor Author

This may be pedantic - but just an FYI this is the one entry in the left hand navigation that requires two lines. maybe we throw in a style to indent the second line or something:

Good idea - I think we should rename this to "Property key policies"

Comment thread sidebars.js Outdated
sksizer
sksizer previously approved these changes Jul 30, 2026

@sksizer sksizer left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm. One nit - I would generally prefer to keep the title as canonical source, and not have a label override in sidebar unless it was an explicit choice

@MadisonEhlers-Vertex
MadisonEhlers-Vertex enabled auto-merge (squash) July 31, 2026 18:46
@MadisonEhlers-Vertex
MadisonEhlers-Vertex enabled auto-merge (squash) August 3, 2026 14:06
@sonarqubecloud

sonarqubecloud Bot commented Aug 3, 2026

Copy link
Copy Markdown

@MadisonEhlers-Vertex
MadisonEhlers-Vertex merged commit b48815c into main Aug 3, 2026
2 checks passed
@MadisonEhlers-Vertex
MadisonEhlers-Vertex deleted the codex/plat-8912 branch August 3, 2026 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants