[Feature] swagger update for mint module (#387)

* swagger update for mint module * change PR template to check swagger udpate
terra-money · Aug 21, 2020 · bd00ed3 · bd00ed3
1 parent 4cc75e5
commit bd00ed3
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 1 deletion.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -6,7 +6,7 @@
 
 - [ ] Github issue OR spec proposal link
 - [ ] Wrote tests
-- [ ] Updated relevant documentation (docs/)
+- [ ] Updated API documentation (client/lcd/swagger-ui/swagger.yaml)
 - [ ] Added a relevant changelog entry: clog add [section] [stanza] [message]
 
 ----

diff --git a/client/lcd/swagger-ui/swagger.yaml b/client/lcd/swagger-ui/swagger.yaml
@@ -21,6 +21,8 @@ tags:
     description: Slashing module APIs
   - name: Distribution
     description: Fee distribution module APIs
+  - name: Mint
+    description: Minting module APIs
   - name: Supply
     description: Supply module APIs
   - name: Market
@@ -1966,6 +1968,60 @@ paths:
                 type: string
         500:
           description: Internal Server Error
+  /minting/parameters:
+    get:
+      summary: Minting module parameters
+      tags:
+        - Mint
+      produces:
+        - application/json
+      responses:
+        200:
+          description: OK
+          schema:
+            properties:
+              mint_denom:
+                type: string
+              inflation_rate_change:
+                type: string
+              inflation_max:
+                type: string
+              inflation_min:
+                type: string
+              goal_bonded:
+                type: string
+              blocks_per_year:
+                type: string
+        500:
+          description: Internal Server Error
+  /minting/inflation:
+    get:
+      summary: Current minting inflation value
+      tags:
+        - Mint
+      produces:
+        - application/json
+      responses:
+        200:
+          description: OK
+          schema:
+            type: string
+        500:
+          description: Internal Server Error
+  /minting/annual-provisions:
+    get:
+      summary: Current minting annual provisions value
+      tags:
+        - Mint
+      produces:
+        - application/json
+      responses:
+        200:
+          description: OK
+          schema:
+            type: string
+        500:
+          description: Internal Server Error
   /supply/total:
     get:
       summary: Total supply of coins in the chain