Skip to content

define openapi schemas for meshmodel component and relationship summary filters #747

@Amr-Shams

Description

@Amr-Shams

the meshery pr (meshery/meshery#917) adds summary filter apis for components and relationships in the registry. reviewers (@lekaf974 , @aabidsofi19 ) agreed that the filter/response structs should live in meshery/schemas as the source of truth, not in the meshery repo directly.

looking for alignment on the schema design before updating the existing pr (#616).

proposed schemas:

  • ComponentSummaryFilter filter params (model, category, registrant, annotations)
  • ComponentSummary response with grouped entries
  • ComponentGroupEntry single group row (key + count)
  • RelationshipSummaryFilter filter params (model, kind, type, subtype)
  • RelationshipSummary response with grouped entries
  • RelationshipGroupEntry single group row (key + count)

open question from gemini review: the generated Summary structs use anonymous structs instead of reusing GroupEntry types should the schema use $ref to the entry type to avoid duplication in codegen output?

ref: meshery/meshery#917, #616, #615

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions