Skip to content

Add Custom Metadata overlay for SDK groups and PropertyDefinition narrowing#101

Open
chinmaya-singal-glean wants to merge 1 commit intohonor-path-level-servers-in-transformerfrom
custom-metadata-overlay
Open

Add Custom Metadata overlay for SDK groups and PropertyDefinition narrowing#101
chinmaya-singal-glean wants to merge 1 commit intohonor-path-level-servers-in-transformerfrom
custom-metadata-overlay

Conversation

@chinmaya-singal-glean
Copy link
Copy Markdown

@chinmaya-singal-glean chinmaya-singal-glean commented May 7, 2026

Summary

Stacked on #100 — depends on the transformer fix landing first so the path keys end up at /rest/api/index/... (rather than the doubled-prefix variant the transformer currently produces for path-level-server endpoints).

  • Groups all 5 Custom Metadata endpoints under indexing.customMetadata in generated SDKs and applies clean method names (upsert, delete, getSchema, upsertSchema, deleteSchema).
  • Introduces a CustomMetadataPropertyDefinition schema that exposes only name, propertyType, and skipIndexing, and re-points CustomMetadataSchema.metadataKeys.items to it. The shared PropertyDefinition schema (used by the Datasource / Custom Properties API) carries fields like displayLabel, displayLabelPlural, uiOptions, hideUiFacet, uiFacetOrder, group that are not relevant to Custom Metadata. We can't strip them from PropertyDefinition itself without affecting the Indexing API surface, so we narrow via a separate schema.
  • Registers the overlay in both glean-api-specs and glean-indexing-api-specs.

Stacking

Test plan

  • pnpm test — all tests pass

🤖 Generated with Claude Code

…rowing

Stacked on #100 — relies on the transformer fix to produce path keys under
/rest/api/index, which is what this overlay's targets are written against.

- Groups all 5 Custom Metadata endpoints under indexing.customMetadata in
  generated SDKs and applies clean method names (upsert, delete, getSchema,
  upsertSchema, deleteSchema).
- Introduces a CustomMetadataPropertyDefinition schema that exposes only
  name, propertyType, and skipIndexing, and re-points
  CustomMetadataSchema.metadataKeys.items to it. The shared PropertyDefinition
  schema (used by the Datasource / Custom Properties API) carries fields
  that are not relevant to Custom Metadata; we cannot strip them from
  PropertyDefinition itself without affecting the Indexing API surface.
- Registers the overlay in both glean-api-specs and glean-indexing-api-specs.

The Custom Metadata endpoints themselves are still x-internal: true upstream
in scio. This overlay is a no-op until that flag is removed in Phase 2;
landing it here ahead of time so the SDK shape is in place when GA flips.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@chinmaya-singal-glean chinmaya-singal-glean marked this pull request as ready for review May 7, 2026 16:32
@chinmaya-singal-glean chinmaya-singal-glean requested a review from a team as a code owner May 7, 2026 16:32
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.

1 participant