chore(docs): restructure Discovery page and add Architecture Response Objects

[marythought]

Summary

Discovery Page

• Add Setup section with client init for Go, Java, JS
• Add Signature → Parameters → Example → Returns to all 5 methods
• Strip inline JS auth setup from examples (now in Setup)
• Link Returns to Policy type references (Attribute, Attribute Value objects)

Architecture Page

• Add Response Objects section showing getter patterns across Go/Java/JS
• Four examples: GetAttributeValue (single), ListAttributeValues (list), GetDecision (decision), GetEntitlements (map)

Part of #274

Test plan

• Verify Discovery page renders all methods with structured docs
• Verify links to Policy type references work
• Verify Architecture Response Objects examples render

🤖 Generated with Claude Code

Summary by CodeRabbit

Documentation

• Reorganized SDK docs with a consistent Setup section for Go, Java, and JavaScript initialization
• Enhanced method pages with explicit Signature, Parameters, and Returns sections
• Added a Response Objects section showing how to read API responses in each language
• Reworked examples to extract client setup, simplify JS usage (no inline auth), tighten error text, and rename "Putting It Together" to "Typical Workflow"

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 08dde475-6d99-4fd0-a108-73f901f31678

📥 Commits

Reviewing files that changed from the base of the PR and between 4bbc881 and 4ee7581.

📒 Files selected for processing (2)

• docs/sdks/discovery.mdx
• docs/sdks/platform-client.mdx

---

📝 Walkthrough

Walkthrough

Documentation updates to SDK reference pages: added a standardized Setup section with Go/Java/JavaScript client initialization, restructured several discovery method docs with explicit signatures/params/returns, and added a "Response Objects" guide with language-specific examples for reading protobuf responses.

Changes

Cohort / File(s)	Summary
Discovery SDK Documentation docs/sdks/discovery.mdx	Added a top-level Setup section with Go/Java/JavaScript client/auth initialization; expanded ListAttributes, AttributeExists, AttributeValueExists, ValidateAttributes, GetEntityAttributes to include Signature, Parameters, Returns and per-language call forms; moved SDK init out of workflow examples, renamed "Putting It Together" → "Typical Workflow"; simplified JS examples to rely on shared auth and removed inline token/provider construction.
Platform Client Documentation docs/sdks/platform-client.mdx	Renamed page/heading from "Architecture" to "Overview"; added a "Response Objects" section describing protobuf return objects and language-specific access patterns (Go getters, Java getters, JS direct properties); appended language-tabbed examples for GetAttributeValue, ListAttributeValues, GetDecision, and GetEntitlements illustrating field access and list iteration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• feat(docs): update JS SDK examples to interceptor auth pattern #270 — Updates JS SDK auth examples to use interceptor/token-provider patterns instead of inline auth construction (same auth-example change pattern).
• chore(docs): restructure Discovery page and add Architecture Response Objects #283 — Makes similar documentation restructures to discovery and platform-client docs (Setup section and Response Objects / method doc changes).

Suggested reviewers

• elizabethhealy
• jp-ayyappan

Poem

🐰 Hopped through docs with a nibble and pen,
I gathered setups for Go, Java, and Zen.
Responses unpacked in each language's song,
Workflow now tidy — the examples sing along! 🥕✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title references the main changes: restructuring the Discovery page and adding Response Objects to the Architecture page, which aligns with the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/274-e-discovery-architecture

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Code Review

This pull request updates the SDK documentation for Discovery and Platform Client by adding a centralized setup section, detailed method signatures, and a guide for handling protobuf response objects across Go, Java, and JavaScript. The review feedback identifies opportunities to improve language neutrality in documentation tables, maintain variable name consistency in JavaScript examples, and correct return type descriptions for JavaScript-specific calls.

[github-actions]

📄 Preview deployed to https://opentdf-docs-pr-283.surge.sh

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/sdks/discovery.mdx`:
- Around line 492-506: Update the parameters docs to explicitly document the JS
request shape: mention that the JS SDK does not expose getEntityAttributes and
that callers should use PlatformClient.getEntitlements with an object payload
containing entityIdentifier; add a JS-specific parameter note or new table row
describing the expected key name (entityIdentifier) and its accepted values
(email, username, client ID, UUID) and reference PlatformClient.getEntitlements
and getEntityAttributes to avoid confusion.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b08994e1-1218-4e83-9d31-3788da7afa5b

📥 Commits

Reviewing files that changed from the base of the PR and between 930f7d2 and 4bbc881.

📒 Files selected for processing (2)

• docs/sdks/discovery.mdx
• docs/sdks/platform-client.mdx