Improve swagger document; Add user and group documents; Fix settings …

…API.

CHANGELOG.md

@@ -4,6 +4,22 @@ All notable changes to this project will be documented in this file starting fro
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 -----
+## [1.2.2] - 2020-04-01
+
+**Change:**
+
+- Improve swagger document.
+- add user and group documents.
+
+**Fixed:**
+
+- Fix settings API.
+
+## [1.2.1] - 2020-03-29
+
+**Change:**
+
+- Update Gear version.
 
 ## [1.2.0] - 2020-03-25
 

Makefile

@@ -13,10 +13,12 @@ test:
 doc:
   # https://github.com/Mermade/widdershins
 	# Install: npm i -g widdershins
-	echo "# Content generated by 'make doc'. DO NOT EDIT.\n" > doc/swagger.yaml
-	cat doc/swagger_header.yaml >> doc/swagger.yaml
-	cat doc/swagger_user.yaml >> doc/swagger.yaml
-	widdershins --language_tabs 'shell:Shell' 'http:HTTP' --summary doc/swagger.yaml -o doc/api.md
+	echo "# Content generated by 'make doc'. DO NOT EDIT.\n" > doc/openapi.yaml
+	cat doc/openapi_header.yaml >> doc/openapi.yaml
+	cat doc/paths_version.yaml >> doc/openapi.yaml
+	cat doc/paths_user.yaml >> doc/openapi.yaml
+	cat doc/paths_group.yaml >> doc/openapi.yaml
+	widdershins --language_tabs 'shell:Shell' 'http:HTTP' --summary doc/openapi.yaml -o doc/openapi.md
 
 BUILD_TIME := $(shell date -u +"%FT%TZ")
 BUILD_COMMIT := $(shell git rev-parse HEAD)

README.md

@@ -10,4 +10,4 @@
 
 ## Documentation (WIP)
 
-[API 文档](https://github.com/teambition/urbs-setting/blob/master/doc/api.md)
+[API 文档](https://github.com/teambition/urbs-setting/blob/master/doc/openapi.md)