finrep-report/backend/finrep-contract/openapi/outline-api.yaml

openapi: 3.0.3
info:
  title: Financial Report Generation - Outline API
  version: 1.0.0
  description: 大纲管理API
servers:
  - url: http://localhost:8080/api/v1
    description: 本地开发环境
  - url: https://api.finrep.example.com/api/v1
    description: 生产环境
tags:
  - name: Outline
    description: 大纲管理

paths:
  /tasks/{taskId}/outline:
    get:
      summary: 查询任务大纲
      tags:
        - Outline
      parameters:
        - name: taskId
          in: path
          required: true
          schema:
            type: string
        - name: tenantId
          in: header
          required: true
          schema:
            type: string
        - name: type
          in: query
          schema:
            type: string
            enum: [LEVEL1, LEVEL2]
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutlineResponse'

    post:
      summary: 创建大纲
      tags:
        - Outline
      parameters:
        - name: taskId
          in: path
          required: true
          schema:
            type: string
        - name: tenantId
          in: header
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OutlineRequest'
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutlineResponse'

  /outline/{outlineId}:
    get:
      summary: 查询大纲详情
      tags:
        - Outline
      parameters:
        - name: outlineId
          in: path
          required: true
          schema:
            type: string
        - name: tenantId
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutlineResponse'

    put:
      summary: 更新大纲
      tags:
        - Outline
      parameters:
        - name: outlineId
          in: path
          required: true
          schema:
            type: string
        - name: tenantId
          in: header
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OutlineRequest'
      responses:
        '200':
          description: 成功

  /outline/{outlineId}/confirm:
    post:
      summary: 确认大纲
      tags:
        - Outline
      parameters:
        - name: outlineId
          in: path
          required: true
          schema:
            type: string
        - name: tenantId
          in: header
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                confirmerId:
                  type: string
                  description: 确认人ID
                confirmerName:
                  type: string
                  description: 确认人名称
      responses:
        '200':
          description: 成功

components:
  schemas:
    OutlineRequest:
      type: object
      required:
        - title
        - type
      properties:
        title:
          type: string
          description: 大纲标题
          maxLength: 255
        type:
          type: string
          description: 大纲类型
          enum: [LEVEL1, LEVEL2]
        rootNode:
          $ref: '#/components/schemas/OutlineNode'
        sections:
          type: array
          items:
            $ref: '#/components/schemas/OutlineSection'
        knowledgeUnitIds:
          type: array
          items:
            type: string
          description: 知识单元ID列表

    OutlineResponse:
      type: object
      properties:
        outlineId:
          type: string
          description: 大纲ID
        taskId:
          type: string
          description: 任务ID
        tenantId:
          type: string
          description: 租户ID
        title:
          type: string
          description: 大纲标题
        type:
          type: string
          description: 大纲类型
        rootNode:
          $ref: '#/components/schemas/OutlineNode'
        sections:
          type: array
          items:
            $ref: '#/components/schemas/OutlineSection'
        knowledgeUnitIds:
          type: array
          items:
            type: string
        confirmed:
          type: boolean
          description: 确认状态
        confirmerId:
          type: string
          description: 确认人ID
        confirmerName:
          type: string
          description: 确认人名称
        confirmTime:
          type: string
          format: date-time
          description: 确认时间
        createTime:
          type: string
          format: date-time
          description: 创建时间
        updateTime:
          type: string
          format: date-time
          description: 更新时间

    OutlineNode:
      type: object
      properties:
        nodeId:
          type: string
          description: 节点ID
        chapterNumber:
          type: string
          description: 章节编号
        title:
          type: string
          description: 章节标题
        description:
          type: string
          description: 章节描述
        parentId:
          type: string
          description: 父节点ID
        children:
          type: array
          items:
            $ref: '#/components/schemas/OutlineNode'
        level:
          type: integer
          description: 节点层级
        knowledgeUnitId:
          type: string
          description: 知识单元ID
        dataBinding:
          type: object
          description: 数据绑定配置
        sortOrder:
          type: integer
          description: 排序号

    OutlineSection:
      type: object
      properties:
        sectionId:
          type: string
          description: 章节ID
        sectionCode:
          type: string
          description: 章节编码
        sectionName:
          type: string
          description: 章节名称
        sectionType:
          type: string
          description: 章节类型
        description:
          type: string
          description: 描述
        knowledgeUnitId:
          type: string
          description: 知识单元ID
        dataBinding:
          type: object
          description: 数据绑定配置
        sortOrder:
          type: integer
          description: 排序号