corrected api specs

Author: prkhrkat

specs/app-store.yaml

@@ -2,11 +2,64 @@ openapi: "3.0.0"
 info:
   version: 1.0.0
   title: Devtron Labs
+  description: Devtron API for app store management
+  termsOfService: https://devtron.ai/terms/
+  contact:
+    name: Devtron Labs
+    email: [email protected]
+    url: https://devtron.ai
+  license:
+    name: Apache 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0.html
+servers:
+  - url: http://localhost:8080/orchestrator
 paths:
-  /orchestrator/app-store/discover/:
+  /app-store/discover:
     get:
       description: this api will return all the charts from charts repos.
-      parameters: [ ]
+      parameters:
+        - name: includeDeprecated
+          in: query
+          description: include deprecated charts
+          required: false
+          schema:
+            type: boolean
+        - name: chartRepoId
+          in: query
+          description: chart repository ids (comma separated)
+          required: false
+          schema:
+            type: string
+        - name: registryId
+          in: query
+          description: registry ids (comma separated)
+          required: false
+          schema:
+            type: string
+        - name: appStoreName
+          in: query
+          description: app store name filter
+          required: false
+          schema:
+            type: string
+        - name: offset
+          in: query
+          description: offset for pagination
+          required: false
+          schema:
+            type: integer
+        - name: size
+          in: query
+          description: size for pagination
+          required: false
+          schema:
+            type: integer
+        - name: chartCategoryId
+          in: query
+          description: chart category ids (comma separated)
+          required: false
+          schema:
+            type: string
       responses:
         '200':
           description: list response
@@ -21,15 +74,10 @@ paths:
                     type: string
                     description: status
                   result:
-                    allOf:
-                      - type: object
-                        properties:
-                          appId:
-                            type: integer
-                            description: unique application id
-                        required:
-                          - appId
-                      - $ref: '#/components/schemas/AppStore'
+                    type: array
+                    description: app store applications with versions
+                    items:
+                      $ref: '#/components/schemas/AppStoreWithVersion'
         default:
           description: unexpected error
           content:
@@ -45,11 +93,8 @@ paths:
 # components mentioned below
 components:
   schemas:
-    AppStore:
+    AppStoreWithVersion:
       type: object
-      required:
-        - id
-        - name
       properties:
         id:
           type: integer
@@ -60,13 +105,13 @@ components:
         appStoreApplicationVersionId:
           type: integer
           description: app store version id
-        chart_git_location:
+        chartGitLocation:
           type: string
           description: chart git repo location
-        chart_name:
+        chartName:
           type: string
           description: chart name
-        chart_repo_id:
+        chartRepoId:
           type: integer
           description: app store and chart repo link id
         deprecated:
@@ -78,18 +123,26 @@ components:
         icon:
           type: string
           description: app store icon link
-        created_on:
+        createdOn:
           type: string
+          format: date-time
           description: created on
-        updated_on:
+        updatedOn:
           type: string
+          format: date-time
           description: modification date
         version:
           type: string
           description: app store version
         active:
           type: boolean
           description: active app store
+        chartRepoName:
+          type: string
+          description: chart repository name
+        isChartRepoActive:
+          type: boolean
+          description: whether chart repository is active
 
     ErrorResponse:
       required:

specs/application.yaml

@@ -2,8 +2,19 @@ openapi: "3.0.0"
 info:
   version: 1.0.0
   title: Devtron Labs
+  description: Devtron API for application management
+  termsOfService: https://devtron.ai/terms/
+  contact:
+    name: Devtron Labs
+    email: [email protected]
+    url: https://devtron.ai
+  license:
+    name: Apache 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0.html
+servers:
+  - url: http://localhost:8080/orchestrator
 paths:
-  /orchestrator/app:
+  /core/v1beta1/application:
     post:
       description: create new application
       requestBody:
@@ -12,7 +23,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/App'
+              $ref: '#/components/schemas/CreateAppRequest'
       responses:
         '200':
           description: App create response
@@ -27,24 +38,15 @@ paths:
                     type: string
                     description: status
                   result:
-                    type: object
-                    description: string
-                    allOf:
-                      - type: object
-                        properties:
-                          id:
-                            type: integer
-                            description: unique application id
-                        required:
-                          - id
-                      - $ref: '#/components/schemas/App'
+                    type: string
+                    description: success message
         default:
           description: unexpected error
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
-  /orchestrator/app/edit:
+  /app/edit:
     post:
       description: update application projects and labels
       requestBody:
@@ -86,7 +88,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
 
-  /orchestrator/app/list:
+  /app/list:
     post:
       description: app listing, collection of deployed applications or undeployed or incomplete configured apps.
       requestBody:
@@ -136,7 +138,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
 
-  /orchestrator/app/edit/projects:
+  /app/edit/projects:
     post:
       description: update project for app
       requestBody:
@@ -189,6 +191,24 @@ components:
           type: boolean
           description: Whether to propagate to kubernetes resources
 
+    CreateAppRequest:
+      type: object
+      required:
+        - metadata
+      properties:
+        metadata:
+          $ref: '#/components/schemas/App'
+        appWorkflows:
+          type: array
+          description: app workflows
+          items:
+            type: object
+        environmentOverrides:
+          type: array
+          description: environment overrides
+          items:
+            type: object
+
     App:
       type: object
       required:

specs/cluster_api_spec.yaml

@@ -2,8 +2,19 @@ openapi: "3.0.0"
 info:
   version: 1.0.0
   title: Devtron Labs
+  description: Devtron API for cluster management
+  termsOfService: https://devtron.ai/terms/
+  contact:
+    name: Devtron Labs
+    email: [email protected]
+    url: https://devtron.ai
+  license:
+    name: Apache 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0.html
+servers:
+  - url: http://localhost:8080/orchestrator
 paths:
-  /orchestrator/cluster:
+  /cluster:
     put:
       description: Update Cluster
       operationId: UpdateCluster
@@ -74,7 +85,7 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
-  /orchestrator/cluster/auth-list:
+  /cluster/auth-list:
     get:
       description: list of accessible cluster
       responses:
@@ -109,22 +120,41 @@ components:
       properties:
         id:
           type: integer
+          description: cluster id
         cluster_name:
           type: string
+          description: cluster name
+        description:
+          type: string
+          description: cluster description
         server_url:
           type: string
+          description: server url
         prometheus_url:
           type: string
+          description: prometheus url
         active:
           type: boolean
+          description: whether cluster is active
         config:
           type: object
-          properties:
-            bearer_token:
-              type: string
-              description: it will be empty while fetching, and if no change while updating
-        k8sversion:
+          additionalProperties:
+            type: string
+          description: cluster config
+        prometheusAuth:
+          $ref: '#/components/schemas/PrometheusAuth'
+        k8sVersion:
+          type: string
+          description: kubernetes version
+        errorInConnecting:
           type: string
+          description: error message if cluster failed to connect
+        isVirtualCluster:
+          type: boolean
+          description: whether cluster is virtual
+        agentInstallationStage:
+          type: integer
+          description: agent installation stage
     PrometheusAuth:
       type: object
       properties: