Skip to content

Conversation

@sfc-gh-bnisco
Copy link
Contributor

@sfc-gh-bnisco sfc-gh-bnisco commented Jan 13, 2026

TL;DR

Added JSON schema definitions for the Component Gallery catalog system.

What changed?

  • Created compiled.schema.json which defines the structure for the compiled components catalog
  • Created component.schema.json which defines the structure for individual component submissions
  • Both schemas include detailed validation rules for component metadata including:
    • Required fields (title, author, links, categories)
    • Format validation for URLs, dates, and other fields
    • Constraints on field lengths and content patterns
    • Predefined category options for components

Why make this change?

These schema definitions provide a standardized structure for component submissions and the compiled catalog, ensuring:

  1. Consistent data format for all components in the gallery
  2. Proper validation of component metadata
  3. Clear requirements for contributors submitting new components
  4. Structured format for metrics and ranking data
  5. Foundation for automated validation in the submission process

@sfc-gh-bnisco
Copy link
Contributor Author

sfc-gh-bnisco commented Jan 13, 2026

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR introduces JSON schema definitions for a Component Gallery catalog system. The schemas provide structured validation for component submissions and the compiled component catalog.

Changes:

  • Added component.schema.json for validating individual component submission data
  • Added compiled.schema.json for validating the compiled components catalog structure
  • Defined comprehensive validation rules including required fields, format constraints, and category enumerations

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File Description
directory/schemas/component.schema.json Defines schema for component submission with validation for metadata, author info, links, categories, and governance
directory/schemas/compiled.schema.json Defines schema for compiled catalog including metrics, ranking signals, and aggregated component data

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (1)

directory/schemas/component.schema.json:1

  • Inconsistent capitalization: 'Github' should be 'GitHub' to match the standard brand name and other references in the schema (e.g., 'gitHubUrl' at line 30, 62).
{

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@sfc-gh-bnisco sfc-gh-bnisco force-pushed the 01-13-_feat_add_jsonschemas branch from a2a0b92 to 518eaab Compare January 16, 2026 18:24
Comment on lines +103 to +120
"enum": [
"LLMs",
"Widgets",
"Charts",
"Authentication",
"Connections",
"Images & video",
"Audio",
"Text",
"Maps",
"Dataframes",
"Graphs",
"Molecules & genes",
"Code editors",
"Page navigation",
"Developer tools",
"Integrations"
]

Choose a reason for hiding this comment

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

question: is it safe to assume this isn't difficult to adjust in the future and that this is based on the already existing categories?

Copy link

@sfc-gh-nbellante sfc-gh-nbellante left a comment

Choose a reason for hiding this comment

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

Added 1 non-blocking question

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.

3 participants