Addition of absent meshery server API's #610
Addition of absent meshery server API's #610YASHMAHAKAL wants to merge 10 commits intomeshery:masterfrom
Conversation
Signed-off-by: YASHMAHAKAL <yvsst01@gmail.com>
Signed-off-by: YASHMAHAKAL <yvsst01@gmail.com>
…environment construct Signed-off-by: YASHMAHAKAL <yvsst01@gmail.com>
Summary of ChangesHello @YASHMAHAKAL, I'm Gemini Code Assist1! 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 significantly expands and refines Meshery's REST API definitions across several core domains. It introduces new API constructs for managing applications, patterns, and environments, alongside a suite of system-level endpoints for operational control. These additions aim to provide a more robust and comprehensive programmatic interface for Meshery's functionalities. Highlights
Changelog
Using Gemini Code AssistThe 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
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 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. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces new OpenAPI specifications for application and system APIs and refines existing ones for design, connection, and environment. My review has identified several indentation issues across the new and modified YAML files that could lead to parsing errors and inconsistencies. I've provided specific suggestions to correct these. Additionally, I've noted the use of placeholder schemas in the new API definitions, which should be replaced with concrete schema definitions to ensure correctness and maintainability.
| type: object | ||
| properties: |
| content: | ||
| multipart/form-data: | ||
| schema: | ||
| type: object | ||
| properties: | ||
| uploadYamlYmlFile: | ||
| type: string | ||
| format: binary |
| type: | ||
| type: string | ||
| supported_extensions: | ||
| type: array | ||
| items: | ||
| type: string |
| url: | ||
| type: string | ||
| name: | ||
| type: string |
| description: The source content of the application. | ||
| x-order: 7 | ||
| type: | ||
| $ref: ../../v1alpha1/core/api.yml#/components/schemas/Text |
| type: array | ||
| items: | ||
| type: string |
| description: Successful | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: "#/components/schemas/MesheryPattern" | ||
| "404": | ||
| description: Pattern not found | ||
| "500": | ||
| description: Internal Server Error |
There was a problem hiding this comment.
Incorrect indentation for these response definitions. Please ensure consistent 2-space indentation for readability and to prevent parsing issues.
description: Successful
content:
application/json:
schema:
$ref: "#/components/schemas/MesheryPattern"
"404":
description: Pattern not found
"500":
description: Internal Server Error| content: | ||
| application/json: | ||
| schema: | ||
| type: object # Placeholder for environmentResponseWrapper |
There was a problem hiding this comment.
This API definition uses a placeholder schema (type: object # Placeholder for ...). While this might be acceptable for work in progress, it's crucial to replace these placeholders with actual schema definitions or references before this is considered complete. Using placeholders can lead to incorrect client generation and runtime errors. This comment applies to other placeholders in this file as well (lines 227, 273, 303).
| content: | ||
| application/json: | ||
| schema: | ||
| type: object # Placeholder for systemDatabaseResponseWrapper |
There was a problem hiding this comment.
This API definition uses a placeholder schema (type: object # Placeholder for ...). While this might be acceptable for work in progress, it's crucial to replace these placeholders with actual schema definitions or references before this is considered complete. Using placeholders can lead to incorrect client generation and runtime errors. This comment applies to other placeholders in this file as well.
| type: | ||
| type: integer | ||
| key: | ||
| type: string | ||
| value: | ||
| type: string |
Signed-off-by: YASHMAHAKAL <yvsst01@gmail.com>
Signed-off-by: YASHMAHAKAL <yvsst01@gmail.com>
Signed-off-by: YASHMAHAKAL <yvsst01@gmail.com>
Signed-off-by: YASHMAHAKAL <yvsst01@gmail.com>
Signed-off-by: YASHMAHAKAL <yvsst01@gmail.com>
| description: Server error | ||
|
|
||
| post: | ||
| x-internal: ["cloud"] |
There was a problem hiding this comment.
removed tags to make them both meshery and cloud api's
Signed-off-by: YASHMAHAKAL <yvsst01@gmail.com>
| "500": | ||
| description: Server error | ||
|
|
||
| /api/integrations/connections/{connectionKind}: |
There was a problem hiding this comment.
looks this is not valid current server only support get by connection ID
Signed-off-by: YASHMAHAKAL <yvsst01@gmail.com>
Notes for Reviewers
This PR fixes #
Addition of absent constructs and refining meshery rest api's
Signed commits