Add job attempt schema in api doc (#4376)

src/rest-server/docs/swagger.yaml

@@ -902,6 +902,8 @@ paths:
       summary: Check if job attempts is healthy.
       description: Check if job attempts is healthy.
       operationId: getJobAttemptsHealthz
+      security:
+        - bearerAuth: []
       parameters:
         - $ref: '#/components/parameters/user'
         - $ref: '#/components/parameters/job'
@@ -917,6 +919,8 @@ paths:
       summary: Get all attempts of a job.
       description: Get all attempts of a job.
       operationId: getJobAttempts
+      security:
+        - bearerAuth: []
       parameters:
         - $ref: '#/components/parameters/user'
         - $ref: '#/components/parameters/job'
@@ -934,17 +938,19 @@ paths:
           $ref: '#/components/responses/NoJobError'
         '501':
           $ref: '#/components/responses/UnknownError'
-  '/api/v2/jobs/{user}~{job}/job-attempts/{attempt}':
+  '/api/v2/jobs/{user}~{job}/job-attempts/{attemptIndex}':
     get:
       tags:
         - job history
       summary: Get a specific attempt by attempt index.
       description: Get a specific attempt by attempt index.
       operationId: getJobAttempt
+      security:
+        - bearerAuth: []
       parameters:
         - $ref: '#/components/parameters/user'
         - $ref: '#/components/parameters/job'
-        - $ref: '#/components/parameters/attempt'
+        - $ref: '#/components/parameters/attemptIndex'
       responses:
         '200':
           description: Succeeded
@@ -1061,8 +1067,8 @@ components:
       required: true
       schema:
         type: string
-    attempt:
-      name: attempt
+    attemptIndex:
+      name: attemptIndex
       in: path
       description: attempt index
       required: true
@@ -1775,7 +1781,157 @@ components:
         - data
     JobAttempt:
       type: object
-      description: TODO
+      description: job attempt
+      properties:
+        jobName:
+          type: string
+        frameworkName:
+          type: string
+        uid:
+          type: string
+        userName:
+          type: string
+        state:
+          type: string
+        originState:
+          type: string
+        maxAttemptCount:
+          type: integer
+        attemptIndex:
+          type: integer
+        jobStartedTime:
+          type: integer
+        attemptStartedTime:
+          type: integer
+        attemptCompletedTime:
+          type: integer
+        exitCode:
+          type: integer
+        exitPhrase:
+          type: string
+        exitType:
+          type: string
+        exitDiagnostics:
+          type: object
+          properties:
+            diagnosticsSummary:
+              type: string
+            runtime:
+              type: object
+              properties:
+                exitCode:
+                  type: integer
+                originUserExitCode:
+                  type: integer
+                errorLogs:
+                  type: object
+                  properties:
+                    user:
+                      type: string
+                    platform:
+                      type: string
+                name:
+                  type: string
+            launcher:
+              type: string
+        appExitTriggerMessage:
+          type: string
+        appExitTriggerTaskRoleName:
+          type: string
+        appExitTriggerTaskIndex:
+          type: integer
+        appExitSpec:
+          type: object
+          properties:
+            code:
+              type: integer
+            phrase:
+              type: string
+            issuer:
+              type: string
+            causer:
+              type: string
+            type:
+              type: string
+            stage:
+              type: string
+            behavior:
+              type: string
+            reaction:
+              type: string
+            reason:
+              type: string
+            repro:
+              type: array
+              items:
+                type: string
+            solution:
+              type: array
+              items:
+                type: string
+        appExitDiagnostics:
+          type: string
+        appExitMessages:
+          type: object
+          properties:
+            container:
+              type: string
+            runtime:
+              type: object
+              properties:
+                exitCode:
+                  type: integer
+                originUserExitCode:
+                  type: integer
+                errorLogs:
+                  type: object
+                  properties:
+                    user:
+                      type: string
+                    platform:
+                      type: string
+                name:
+                  type: string
+            launcher:
+              type: string
+        totalGpuNumber:
+          type: integer
+        totalTasknumber:
+          type: integer
+        totalTaskRoleNumber:
+          type: integer
+        taskRoles:
+          type: object
+          properties:
+            taskrole:
+              type: object
+              properties:
+                taskRoleStatus:
+                  type: object
+                  properties:
+                    name:
+                      type: string
+                taskStatuses:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      taskIndex:
+                        type: integer
+                      taskState:
+                        type: string
+                      containerId:
+                        type: string
+                      containerIp:
+                        type: string
+                      containerGpus:
+                        type: string
+                      containerLog:
+                        type: string
+                      containerExitCode:
+                        type: integer
+        isLatest:
+          type: boolean
   responses:
     IncorrectPassworkError:
       description: IncorrectPassworkError

src/rest-server/src/routes/v2/job-attempt.js

@@ -19,20 +19,21 @@
 // module dependencies
 const express = require('express');
 const controller = require('@pai/controllers/v2/job-attempt');
+const token = require('@pai/middlewares/token');
 
 
 const router = new express.Router({mergeParams: true});
 
 /** GET /api/v2/jobs/:frameworkName/job-attempts/healthz - health check of job retry endpoint*/
 router.route('/healthz')
-  .get(controller.healthCheck);
+  .get(token.check, controller.healthCheck);
 
 /** GET /api/v2/jobs/:frameworkName/job-attempts - list job retries by job frameworkName */
 router.route('/')
-  .get(controller.list);
+  .get(token.check, controller.list);
 
 /** GET /api/v2/jobs/:frameworkName/job-attempts/:jobAttemptIndex - get certain job retry by retry index */
 router.route('/:jobAttemptIndex')
-  .get(controller.get);
+  .get(token.check, controller.get);
 
 module.exports = router;