Merge pull request #1775 from visuddhinanda/agile

add corpus to openapi

dashboard/src/components/template/ParaShell.tsx

@@ -59,7 +59,9 @@ const ParaShellCtl = ({
           position: "absolute",
           marginTop: "-2em",
           marginLeft: "1em",
-          backgroundColor: "#d9e9ff",
+          border: isFocus
+            ? "2px solid #e35f00bd "
+            : "2px solid rgba(0, 107, 255, 0.3)",
           borderRadius: "4px",
         }}
       >

openapi/public/assets/protocol/main.yaml

@@ -33,3 +33,5 @@ paths:
     $ref: "./resources/progress/index.yaml"
   /sentence:
     $ref: "./resources/sentence/index.yaml"
+  /corpus:
+    $ref: "./resources/corpus/corpus/index.yaml"

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

@@ -0,0 +1,51 @@
+properties:
+  uid:
+    type: string
+  title:
+    type: string
+  title_text:
+    type: string
+  subtitle:
+    type: string
+  summary:
+    type: string
+  _summary:
+    type: string
+  content:
+    type: string
+  content_type:
+    type: string
+  html:
+    type: string
+  path:
+    type: object
+    properties:
+      key:
+        type: string
+      book:
+        type: number
+      paragraph:
+        type: number
+      title:
+        type: string
+      paliTitle:
+        type: string
+      level:
+        type: number
+  studio:
+    type: object
+    properties:
+      id:
+        type: string
+      nickName:
+        type: string
+      studioName:
+        type: string
+      realName:
+        type: string
+      avatar:
+        type: string
+  created_at:
+    type: string
+  updated_at:
+    type: string

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

@@ -0,0 +1,69 @@
+get:
+  summary: 返回段落信息，包含原文，译文
+  tags:
+    - corpus
+  description: 支持查询多个段落。
+  parameters:
+    - name: view
+      in: query
+      required: true
+      description: 查询什么内容,目前仅支持para 段落查询
+      schema:
+        type: string
+        enum:
+          - para
+    - name: mode
+      in: query
+      required: false
+      description: 返回数据模式。阅读模式巴利原文是markdown数据,编辑模式是json逐词解析数据。
+      schema:
+        type: string
+        enum:
+          - read
+          - edit
+          - wbw
+    - name: channels
+      in: query
+      required: false
+      description: channel id列表。两个channel 之间用下划线_连接。没有channel仅返回巴利原文。
+      schema:
+        type: string
+    - name: book
+      in: query
+      required: true
+      description: 书号 1~217
+      schema:
+        type: number
+    - name: par
+      in: query
+      required: true
+      description: 段落号,两个段落之间用英文逗号连接
+      schema:
+        type: string
+    - name: format
+      in: query
+      required: false
+      description: 返回数据格式 默认react
+      schema:
+        type: string
+        enum:
+          - react
+          - unity
+          - html
+          - tex
+          - text
+  responses:
+    "200": # status code
+      description: A JSON array of user names
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              ok:
+                type: boolean
+              message:
+                type: string
+              data:
+                type: object
+                $ref: "./data.yaml"

openapi/public/assets/protocol/resources/corpus/pali-text/index.yaml

@@ -1,7 +1,7 @@
 get:
   summary: Returns a list of users.
   tags:
-    - corpus
+    - pali-text
   responses:
     "200":
       description: A JSON array of user names

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

@@ -1,5 +1,5 @@
 get:
-  summary: Returns a list of discussions.
+  summary: 返回已有译文的章节信息
   tags:
     - progress
   description: 返回多行数据。支持关键字搜索，分页，排序
@@ -15,13 +15,13 @@ get:
     - name: tags
       in: query
       required: false
-      description: 便签过滤
+      description: 标签过滤。空为全部标签。
       schema:
         type: string
     - name: studio
       in: query
       required: false
-      description: studio过滤
+      description: studio选择。默认选择全部studio
       schema:
         type: string
     - name: progress
@@ -57,14 +57,14 @@ get:
           - commentary
     - name: limit
       in: query
-      description: 每次提取记录数
+      description: 每次提取记录数,默认20
       schema:
         type: number
         minimum: 1
         maximum: 1000
     - name: offset
       in: query
-      description: 从第几条记录开始提取
+      description: 从第几条记录开始提取，默认值0
       schema:
         type: number
   responses:
@@ -79,4 +79,6 @@ get:
                 type: boolean
               message:
                 type: string
+              data:
+                type: object
                 $ref: "./data.yaml"