Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 19, 2025

Notes for Reviewers

This PR fixes #[issue number not provided in context]

Design schema lacked a description field while model and component schemas both include it. This inconsistency prevented documenting design purpose and characteristics.

Changes

  • Schema: Added optional description field to schemas/constructs/v1beta1/design/design.json

    • Positioned after name (x-order: 3)
    • Type: string with omitempty tags
    • Updated x-order for subsequent fields (4-9)
  • Generated Code:

    • Go: Description *string in PatternFile struct
    • TypeScript: description?: string in DesignSchema interface

Example Usage

design := pattern.PatternFile{
    Id:            uuid.NewV4(),
    Name:          "Production Gateway",
    Description:   stringPtr("API gateway configuration for production environment"),
    SchemaVersion: "designs.meshery.io/v1beta1",
    Version:       "v1.0.0",
    // ...
}

Signed commits

  • Yes, I signed my commits.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/meshery/meshery/pulls/16442
    • Triggering command: curl -s REDACTED (http block)
  • https://api.github.com/repos/meshery/meshery/pulls/16442/comments
    • Triggering command: curl -s REDACTED (http block)
  • https://api.github.com/repos/meshery/meshery/pulls/16442/files
    • Triggering command: curl -s REDACTED (http block)
  • otel.cloud.redocly.com
    • Triggering command: node /home/REDACTED/.npm/_npx/1738445911c9ab26/node_modules/.bin/redocly lint schemas/constructs/v1beta1/design/openapi.yml (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>Enhance design schema</issue_title>
<issue_description>### Current Behavior
See https://github.com/meshery/meshery/pull/16442/files#r2537329873

Desired Behavior

Enhance the schema for which this model's struct is designed after.

Implementation

Acceptance Tests

Mockups


Contributor Guides and Handbook

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Enhance design schema for model struct [schemas] Add description field to design schema Nov 19, 2025
Copilot finished work on behalf of leecalcote November 19, 2025 02:41
Copilot AI requested a review from leecalcote November 19, 2025 02:41
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.

Enhance design schema

2 participants