create

openapi/public/assets/protocol/resources/progress/data.yaml

@@ -0,0 +1,58 @@
+properties:
+  title:
+    type: string
+  toc:
+    type: string
+  book:
+    type: string
+  para:
+    type: string
+  path:
+    type: string
+  tags:
+    type: object
+    properties:
+      id:
+        type: string
+      name:
+        type: string
+      description:
+        type: string
+  channel:
+    type: object
+    properties:
+      name:
+        type: string
+      owner_uid:
+        type: string
+  studio:
+    type: object
+    properties:
+      id:
+        type: string
+      nickName:
+        type: string
+      studioName:
+        type: string
+      realName:
+        type: string
+      avatar:
+        type: string
+  channel_id:
+    type: string
+  summary:
+    type: string
+  view:
+    type: number
+  like:
+    type: number
+  status:
+    type: number
+  progress:
+    type: number
+  progress_line:
+    type: number
+  created_at:
+    type: string
+  updated_at:
+    type: string

openapi/public/assets/protocol/resources/progress/index.yaml

@@ -0,0 +1,82 @@
+get:
+  summary: Returns a list of discussions.
+  tags:
+    - progress
+  description: 返回多行数据。支持关键字搜索，分页，排序
+  parameters:
+    - name: view
+      in: query
+      required: true
+      description: 查询什么内容
+      schema:
+        type: string
+        enum:
+          - chapter
+    - name: tags
+      in: query
+      required: false
+      description: 便签过滤
+      schema:
+        type: string
+    - name: studio
+      in: query
+      required: false
+      description: studio过滤
+      schema:
+        type: string
+    - name: progress
+      in: query
+      required: false
+      description: 完成度过滤，默认值0.8
+      schema:
+        type: number
+        minimum: 0
+        maximum: 1
+    - name: lang
+      in: query
+      required: true
+      description: 语言过滤 如zh
+      schema:
+        type: string
+    - name: channel
+      in: query
+      required: false
+      description: channel名称过滤
+      schema:
+        type: string
+    - name: channel_type
+      in: query
+      required: false
+      description: channel类型过滤 默认值 translation
+      schema:
+        type: string
+        enum:
+          - translation
+          - nissaya
+          - original
+          - commentary
+    - name: limit
+      in: query
+      description: 每次提取记录数
+      schema:
+        type: number
+        minimum: 1
+        maximum: 1000
+    - name: offset
+      in: query
+      description: 从第几条记录开始提取
+      schema:
+        type: number
+  responses:
+    "200": # status code
+      description: A JSON array of user names
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              ok:
+                type: boolean
+              message:
+                type: string
+                $ref: "./data.yaml"