Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Server] New views API #10943

Open
5 tasks
leecalcote opened this issue May 13, 2024 · 1 comment
Open
5 tasks

[Server] New views API #10943

leecalcote opened this issue May 13, 2024 · 1 comment
Labels
area/docs Documentation update needed component/api Issues related to API component/server issue/design required Functional architecture issue/willfix This issue will be worked on kind/feature New major feature or request language/go Issues or pull requests that use Golang

Comments

@leecalcote
Copy link
Member

leecalcote commented May 13, 2024

This issue a child issue of the epic described in #10937. See the parent issue for additional context.

Current Behavior

Meshery supports a Views concept as an extension via Remote Providers.

Desired Behavior

Major feature request: Support the Views concept as within the Local Provider.

Implementation

  1. Propose new API endpoint in design spec spreadsheet.
  2. New schema-driven construct in Meshery Server and MeshKit: Views.
  3. Publish schema in github.com/meshery/schemas
  4. Generate Open API compatible scaffolding for Golang-based construct.
  5. Update Meshery Architecture deck with overview of Views construct (same for Meshery Docs and REST API).

Acceptance Tests

  • 1. views schema is published (released) from github.com/meshery/schemas with v1alpha1 version
  • 1. New Concepts page in Meshery Docs.
  • 1. New How to Use Views page in Meshery Docs.
  • 1. New REST API section in Meshery Docs.
  • 1. New "Views" menu item is available in Local and Remote Providers.

Mockups

See support for Meshery Designs. Make a mirror image for Views (more or less).

REST API Docs (but for Views, not Designs)

Screenshot 2024-05-13 at 3 44 31 PM

Contributor Guides and Handbook

@leecalcote leecalcote added issue/design required Functional architecture area/docs Documentation update needed language/go Issues or pull requests that use Golang component/api Issues related to API kind/feature New major feature or request component/server labels May 13, 2024
Copy link

This issue has been labeled with 'design-required'. Note that prior to commencing on implementation, a design specification needs to be created and reviewed for approval. See Creating a Functional Specification to create a design spec.


        Be sure to join the community, if you haven't yet and please leave a ⭐ star on the project 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation update needed component/api Issues related to API component/server issue/design required Functional architecture issue/willfix This issue will be worked on kind/feature New major feature or request language/go Issues or pull requests that use Golang
Projects
None yet
Development

No branches or pull requests

1 participant