SEEC-II/routes/assignment/codework/codehw.raml

#%RAML 1.0

# Project
/projects:
  post:
    displayName: 获取代码作业的项目列表
    body: 
      application/json:
        properties: 
          homeworkId:
            type: integer
            description: 代码作业id
    is: [response: { typeName: 'CodeWorkProject[]' }]
/project:
  /{id}:
    uriParameters: 
      id: 
        type: integer
        description: 项目id
    get:
      displayName: 获取代码作业的项目
      is: [response: { typeName: CodeWorkProject }]
    /build/record:
      get:
        queryParameters: 
          limit:
            type: integer
            default: 5
            description: 数目限制
        displayName: 获取项目的最近limit条构建记录
        is: [response: { typeName: 'BuildRecordDTO[]' }]
    /build/image:
      get:
        displayName: 获取项目的构建镜像记录，用于部署镜像选择
        is: [response: { typeName: DeployImage }]
    /deploy/record:
      get:
        displayName: 获取项目当前的部署记录
        description: 获取项目的部署记录，只包含当前的测试环境和生产环境部署记录
        is: [response: { typeName: CodeWorkDeploy }]
  /deploy/record/{id}:
    uriParameters: 
      id: 
        type: integer
        description: 代码作业小组resultId
    get:
      displayName: 获取代码作业小组的部署记录
      queryParameters: 
        limit:
          type: integer
          default: 5
          description: 条数
        success:
          type: integer
          default: 1
          description: 是否只返回成功的部署记录，1为是，否则返回所有记录
      is: [response: { typeName: 'DeployResponse[]' }]

# Build
/build:
  /{id}:
    uriParameters: 
      id: 
        type: integer
        description: 构建记录id
    get:
      displayName: 获取构建记录
      is: [response: { typeName: BuildRecordDTO }]
  /record/{recordId}:
    uriParameters: 
      recordId: 
        type: integer
        description: 构建记录id，选择已存在的一个构建记录（根据id找到branch和hash，来主动重新构建该次记录）
    post:
      displayName: 主动构建镜像
      is: [response: { typeName: BuildRecordDTO }]

# Deploy
/deploy:
  post:
    displayName: 学生主动进行部署
    body:
      application/json:
        type: DeployDTO
    is: [response: { typeName: DeployResponse }]
  /{deployId}:
    uriParameters: 
      deployId: 
        type: integer
        description: 部署记录id
    get:
      displayName: 获取部署记录
      is: [response: { typeName: DeployResponse }]
  /log/{deployId}:
    uriParameters: 
      deployId: 
        type: integer
        description: 部署记录id
    get:
      displayName: 获取部署应用的日志
      is: [response: { typeName: string }]

# UnitTest
/unit/{id}:
  uriParameters: 
    id: 
      type: integer
      description: 单元测试记录id
  get:
    displayName: 获取单元测试记录
    is: [response: { typeName: UnitTestRecord }]

# FunctionTest
/functional:
  post:
    displayName: 主动触发界面测试
    body:
      application/json:
        type: FunctionalTestDTO
    responses:
      200:
        body:
          type: object
          properties:
            code: integer
            data:
              properties:
                success:
                  type: boolean
                  description: 是否触发成功
  /{id}:
    uriParameters: 
      id: 
        type: integer
        description: 界面测试记录id
    get:
      displayName: 获取单元测试记录
      is: [response: { typeName: FunctionTestRecord }]