f

Author: prkhrkat

specs/apiToken_api-spec.yaml

@@ -3,36 +3,76 @@ info:
   version: 1.0.0
   title: Devtron Labs
 paths:
-  /orchestrator/api-token:
+  /api-token:
     get:
       description: Get All active Api Tokens
       responses:
         "200":
-          description: Successfully fetched active API tokens links
+          description: Successfully fetched active API tokens
           content:
             application/json:
               schema:
                 type: array
                 items:
                   $ref: "#/components/schemas/ApiToken"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
     post:
       description: Create api-token
       requestBody:
         required: true
         content:
           application/json:
             schema:
-              type: array
-              items:
-                $ref: "#/components/schemas/CreateApiTokenRequest"
+              $ref: "#/components/schemas/CreateApiTokenRequest"
       responses:
         "200":
           description: Api-token creation response
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/CreateApiTokenResponse"
-  /orchestrator/api-token/{id}:
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /api-token/{id}:
     put:
       description: Update api-token
       parameters:
@@ -56,6 +96,30 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/UpdateApiTokenResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
     delete:
       description: Delete api-token
       parameters:
@@ -73,6 +137,76 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ActionResponse"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+  /api-token/webhook:
+    get:
+      description: Get all api tokens which have given permission
+      parameters:
+        - name: projectName
+          in: query
+          description: Project name
+          schema:
+            type: string
+        - name: environmentName
+          in: query
+          description: Environment name
+          schema:
+            type: string
+        - name: appName
+          in: query
+          description: Application name
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Successfully fetched API tokens for webhook
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/ApiToken"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "403":
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
 components:
   schemas:
     ApiToken:
@@ -127,6 +261,8 @@ components:
           example: "some date"
     CreateApiTokenRequest:
       type: object
+      required:
+        - name
       properties:
         name:
           type: string
@@ -192,4 +328,15 @@ components:
         token:
           type: string
           description: Token of that api-token
-          example: "some token"
+          example: "some token"
+    ErrorResponse:
+      type: object
+      properties:
+        code:
+          type: integer
+          description: HTTP status code
+          example: 400
+        message:
+          type: string
+          description: Error message
+          example: "Bad Request"