summaryrefslogtreecommitdiff
path: root/src/docs/api
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2018-10-22 05:16:27 +0900
committersyuilo <syuilotan@yahoo.co.jp>2018-10-22 05:16:27 +0900
commit3aece449e4a2134381d69754716906353c2dd8bf (patch)
tree6effa7785bb5f34b79696f4734d236267cb5f361 /src/docs/api
parent#2939 part 3 (#2976) (diff)
downloadsharkey-3aece449e4a2134381d69754716906353c2dd8bf.tar.gz
sharkey-3aece449e4a2134381d69754716906353c2dd8bf.tar.bz2
sharkey-3aece449e4a2134381d69754716906353c2dd8bf.zip
Improve API definitions
Diffstat (limited to 'src/docs/api')
-rw-r--r--src/docs/api/endpoints/style.styl17
-rw-r--r--src/docs/api/endpoints/view.pug5
2 files changed, 22 insertions, 0 deletions
diff --git a/src/docs/api/endpoints/style.styl b/src/docs/api/endpoints/style.styl
index e7e32b3395..56ad291627 100644
--- a/src/docs/api/endpoints/style.styl
+++ b/src/docs/api/endpoints/style.styl
@@ -21,3 +21,20 @@
> .host
opacity 0.7
+
+#stability
+ padding 8px 12px
+ color #fff
+ border-radius 4px
+
+ &.deprecated
+ background #f42443
+
+ &.experimental
+ background #f2781a
+
+ &.stable
+ background #3dcc90
+
+ > b
+ margin-left 4px
diff --git a/src/docs/api/endpoints/view.pug b/src/docs/api/endpoints/view.pug
index be7e84faa1..696ec4050f 100644
--- a/src/docs/api/endpoints/view.pug
+++ b/src/docs/api/endpoints/view.pug
@@ -14,6 +14,11 @@ block main
| /
span.path= endpointUrl.path
+ - var stability = endpoint.stability || 'experimental';
+ p#stability(class=stability)
+ | Stability:
+ b= stability
+
if endpoint.desc
p#desc= endpoint.desc[lang] || endpoint.desc['ja-JP']