Skip to content

[docs-agent] Fix Solana DAS options schema (showInscription typo + add missing options param)#1315

Open
JackReacher0807 wants to merge 1 commit into
mainfrom
docs/solana-das-options-schema-fixes
Open

[docs-agent] Fix Solana DAS options schema (showInscription typo + add missing options param)#1315
JackReacher0807 wants to merge 1 commit into
mainfrom
docs/solana-das-options-schema-fixes

Conversation

@JackReacher0807
Copy link
Copy Markdown
Collaborator

Summary

The Solana DAS API docs listed a displayOptions / options schema that was out of sync with what the Alchemy DAS proxy actually accepts, scattered across six methods. This PR aligns the spec with the live backend.

Confirmed against solana-mainnet.g.alchemy.com/v2/docs-demo — the server enumerates the canonical 5-flag set verbatim in its unknown field ... expected one of ... error:

showUnverifiedCollections, showCollectionMetadata, showZeroBalance, showInscription, showFungible

All boolean, all default false. Note showInscription is singular.

Shared DisplayOptions schema (src/openrpc/chains/_components/solana/asset.yaml)

  • Rename showInscriptionsshowInscription (the plural spelling is rejected by the backend).
  • Drop showNativeBalance (rejected).
  • Drop showGrandTotal (rejected).
  • Tighten property descriptions to match the searchAssets reference.

Per-method updates (src/openrpc/alchemy/solana-das/solana-das.yaml)

Method Change
getAsset Refresh existing displayOptions description with the options alias note.
getAssets Same.
getAssetsByOwner Refresh existing options description with the displayOptions alias note.
getAssetsByAuthority Add missing options param using the shared schema.
getAssetsByCreator Add missing options param using the shared schema.
getAssetsByGroup Add missing options param using the shared schema.

All six methods now mirror the alias note pattern from searchAssets: the backend accepts both options and displayOptions as aliases, but only one may be present per request (duplicate field error otherwise, confirmed live).

Verification

  • pnpm run generate:rpc
  • pnpm run validate:rpc
  • Live API smoke tests against solana-mainnet.g.alchemy.com/v2/docs-demo:
    • getAsset with the new 5-flag displayOptions → 200 with the requested asset.
    • getAssetsByGroup with options.showCollectionMetadata: true → 200 with 2 items.
    • getAssetsByAuthority with displayOptions alias → 200 with 2 items.
    • getAssetsByAuthority with BOTH options and displayOptions set → duplicate field error (confirms the alias note's "only one may be present" caveat).

Linear

DOCS-92

Requested by

@victorbware (via Slack thread)

…d missing options param)

Update the shared DisplayOptions schema in chains/_components/solana/asset.yaml
to match what the Alchemy DAS proxy actually accepts:

* rename showInscriptions -> showInscription (typo fix; backend rejects the
  plural spelling)
* remove showNativeBalance and showGrandTotal (not accepted by the backend)
* tighten property descriptions to match the searchAssets reference

Update src/openrpc/alchemy/solana-das/solana-das.yaml so all 6 affected
methods carry the same alias note searchAssets uses (`options` and
`displayOptions` are server-side aliases; only one may be present):

* getAsset, getAssets: refresh the existing displayOptions description
* getAssetsByOwner: refresh the existing options description
* getAssetsByAuthority, getAssetsByCreator, getAssetsByGroup: add the
  missing options parameter referencing the shared DisplayOptions schema

Verified against solana-mainnet.g.alchemy.com/v2/docs-demo: the 5-flag
schema (showUnverifiedCollections, showCollectionMetadata, showZeroBalance,
showInscription, showFungible) is enumerated verbatim in the server's
"unknown field ... expected one of ..." error, and all 3 newly-augmented
methods return real data when called with the documented options shape.

Refs DOCS-92

Requested-by: @victorbware
@JackReacher0807 JackReacher0807 requested a review from a team as a code owner May 21, 2026 08:29
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 21, 2026

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview May 21, 2026, 8:30 AM

@github-actions
Copy link
Copy Markdown

🔍 Link Check

Status: ⏭️ Skipped (no content changes)

View workflow run

victorbware
victorbware previously approved these changes May 21, 2026
@github-actions github-actions Bot dismissed victorbware’s stale review May 21, 2026 08:39

@victorbware you are listed as the originator of this docs request (via the Requested-by trailer on a docs-agent commit). Per the docs-agent self-review policy, the originator can't approve their own request. Please ask another team member to review.

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.

4 participants