Add draft provider capability schema

[marblom007]

Summary

Moves the new v1beta1 cloud/provider capability schema out of PR #629 into a separate draft for naming and public API review.

Notes

• extracted from PR Code generator scripts refactor; Add credential, role, and schedule construct schemas with Go models #629 per review feedback
• currently scoped to the source schema only
• naming and differentiation from v1alpha1 capability remains under discussion

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new v1beta1 OpenAPI schema for Meshery Cloud provider capabilities. Its primary purpose is to establish a dedicated draft for the schema, allowing for focused review and discussion on its naming conventions and overall public API design, separate from a larger, ongoing development effort.

Highlights

• New API Schema Draft: Introduced a new v1beta1 OpenAPI schema for Meshery Cloud provider capabilities as a separate draft for focused review and discussion on naming and public API design.
• Extraction from Existing PR: This schema was extracted from a larger pull request (Code generator scripts refactor; Add credential, role, and schedule construct schemas with Go models #629) based on reviewer feedback to streamline the review process.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new OpenAPI schema for provider capabilities in v1beta1. The schema is generally well-structured, but there are several areas for improvement to enhance clarity, validation, and maintainability. My review focuses on adding missing property descriptions, defining empty object schemas, using appropriate types and formats for fields like URIs and version strings, and clarifying ambiguous property definitions.

[gemini-code-assist]

The allowedTo property is defined as an empty object, which is ambiguous for clients. Please define its properties. If the structure is not yet finalized, a description indicating this and that it's a placeholder for future properties would be helpful. If it's intended to be a flexible key-value map, consider using additionalProperties: true.

          type: object
          description: "Permissions for this item. Structure to be defined."

[gemini-code-assist]

Many properties within CapabilityNavigatorExtension (and other schemas in this file) lack description fields. For example, it's unclear what onClickCallback, component, icon, and type represent. Adding descriptions is crucial for API clarity and maintainability, making it easier for developers to understand and use the API correctly.

[gemini-code-assist]

The property onClickCallback has type integer, which is an unusual type for a "callback". Please add a description to clarify what this integer represents (e.g., an ID). If it's meant to be a function name, string would be a more appropriate type. This also applies to CapabilityAccountExtension.

[gemini-code-assist]

The uri property should have format: uri to enable better validation and tooling support. This also applies to the uri property in CapabilityAccountExtensionHref.

        uri:
          type: string
          format: uri