Merge pull request #60 from ggtakec/fix_ghp

[gh-pages] Refixed api_tenant(ja).md and fixed api_extdata(ja).md for liquid template
yahoojapan · Jul 7, 2023 · f086d7d · f086d7d
2 parents e7795c0 + da57668
commit f086d7d
Show file tree

Hide file tree

Showing 4 changed files with 169 additions and 165 deletions.
diff --git a/api_extdata.md b/api_extdata.md
@@ -13,7 +13,7 @@ next_url:
 next_string: 
 ---
 
-# EXTDATA API
+# USERDATA API
 This page describes K2HR3 EXTRA DATA API.  
 
 This API is an API that expands the template defined by the user and returns the expanded data.  
@@ -88,6 +88,7 @@ The template expanded data will be returned. Note that the URL path must contain
 
 ##### Example: template
 ```
+{% raw %}
 #/bin/sh
 
 ROLE_NAME={{= %K2HR3_ROLE_NAME% }}
@@ -103,6 +104,7 @@ echo "K2HR3_API_HOST: ${K2HR3_API_HOST}"
 echo "ERROR_MSG:      ${ERROR_MSG}"
 
 exit 0
+{% endraw %}
 ```
 
 ##### Example: response

diff --git a/api_extdataja.md b/api_extdataja.md
@@ -91,6 +91,7 @@ Gzip圧縮された場合とTextの場合は共に内容は同じです。（Gzi
 
 ##### 例：テンプレート
 ```
+{% raw %}
 #/bin/sh
 
 ROLE_NAME={{= %K2HR3_ROLE_NAME% }}
@@ -106,6 +107,7 @@ echo "K2HR3_API_HOST: ${K2HR3_API_HOST}"
 echo "ERROR_MSG:      ${ERROR_MSG}"
 
 exit 0
+{% endraw %}
 ```
 
 ##### 例：レスポンス

diff --git a/api_tenant.md b/api_tenant.md
@@ -65,7 +65,7 @@ It is necessary to specify the USER name registered in the K2HR3 system, and if
 And the USER name can not set as [YRN](detail_variousen.html) full path.  
 
 ### Response status
-201¿40x
+201, 40x
 
 ### Response Body(JSON)
 ```
@@ -87,7 +87,7 @@ All TENANT APIs require an Unscoped User Token or a Scoped User Token.
 If a Scoped User Token is specified, the tenant indicated by that token will be ignored and only the USER information will be used as with the Unscoped User Token.  
 
 ### Endpoint(URL)
-http(s)://_API SERVER:PORT_/v1/tenant{?name=...}
+http(s)://_API SERVER:PORT_/v1/tenant?name=_tenant name_&...
 
 ### Header
 ```
@@ -112,7 +112,7 @@ It is necessary to specify the USER name registered in the K2HR3 system, and if
 And the USER name can not set as [YRN](detail_variousen.html) full path.  
 
 ### Response status
-201¿40x
+201, 40x
 
 ### Response Body(JSON)
 ```
@@ -174,7 +174,7 @@ It is necessary to specify the USER name registered in the K2HR3 system, and if
 And the USER name can not set as [YRN](detail_variousen.html) full path.  
 
 ### Response status
-201¿40x
+201, 40x
 
 ### Response Body(JSON)
 ```
@@ -196,7 +196,7 @@ All TENANT APIs require an Unscoped User Token or a Scoped User Token.
 If a Scoped User Token is specified, the tenant indicated by that token will be ignored and only the USER information will be used as with the Unscoped User Token.  
 
 ### Endpoint(URL)
-http(s)://_API SERVER:PORT_/v1/tenant/_tenant name_{?id=...}
+http(s)://_API SERVER:PORT_/v1/tenant/_tenant name_?id=_tenant id_
 
 - tenant name  
 Specify the K2HR3 cluster Local Tenant(TENANT) name.  
@@ -226,7 +226,7 @@ It is necessary to specify the USER name registered in the K2HR3 system, and if
 And the USER name can not set as [YRN](detail_variousen.html) full path.  
 
 ### Response status
-201¿40x
+201, 40x
 
 ### Response Body(JSON)
 ```
@@ -249,7 +249,7 @@ All TENANT APIs require an Unscoped User Token or a Scoped User Token.
 If a Scoped User Token is specified, the tenant indicated by that token will be ignored and only the USER information will be used as with the Unscoped User Token.  
 
 ### Endpoint(URL)
-http(s)://_API SERVER:PORT_/v1/tenant{?expand=true/false}
+http(s)://_API SERVER:PORT_/v1/tenant?expand=_true or false_
 
 ### Header
 ```
@@ -264,10 +264,10 @@ Specify _true_ as this value to expand.
 When specify _true_, it contains all information for each TENANT.  
 
 ### Response status
-200¿40x
+200, 40x
 
 ### Response Body(JSON) 
-- Expanding¿expand=true¿  
+- Expanding (expand=true)  
 ```
 {
     result:           <true/false>
@@ -284,7 +284,7 @@ When specify _true_, it contains all information for each TENANT.
     ]
 }
 ```
-- Not expanding¿expand=false¿  
+- Not expanding(expand=false)  
 ```
 {
     result:   <true/false>
@@ -334,7 +334,7 @@ x-auth-token: U=<Scoped User Token>
 ```
 
 ### Response status
-200¿40x
+200, 40x
 
 ### Response Body(JSON) 
 ```
@@ -388,7 +388,7 @@ x-auth-token: U=<Scoped User Token>
 ```
 
 ### Response status
-204¿40x
+204, 40x
 
 ### Response Body(JSON)
 Empty
@@ -403,7 +403,7 @@ All TENANT APIs require an Unscoped User Token or a Scoped User Token.
 If a Scoped User Token is specified, the tenant indicated by that token will be ignored and only the USER information will be used as with the Unscoped User Token.  
 
 ### Endpoint(URL)
-http(s)://_API SERVER:PORT_/v1/tenant/_tenant name_{?id=<tenant id>}
+http(s)://_API SERVER:PORT_/v1/tenant/_tenant name_?id=_tenant id_
 
 - tenant name  
 Specify the K2HR3 cluster Local Tenant(TENANT) name.  
@@ -422,7 +422,7 @@ Specify the _ID_ of the K2HR3 cluster Local Tenant(TENANT).
 If the K2HR3 Cluster Local Tenant(TENANT) name and this _ID_ value do not match, it will be failure.  
 
 ### Response status
-204¿40x
+204, 40x
 
 ### Response Body(JSON)
 Empty