diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2019-02-24 12:53:22 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2019-02-24 12:53:22 +0900 |
| commit | 9b79a411e0d0ecd57c52f0878d2873f925eebc4f (patch) | |
| tree | 4ffe7b6376f35fc2620459669a407612f8f70ce6 /src/server/api/openapi | |
| parent | Improve doc (diff) | |
| download | sharkey-9b79a411e0d0ecd57c52f0878d2873f925eebc4f.tar.gz sharkey-9b79a411e0d0ecd57c52f0878d2873f925eebc4f.tar.bz2 sharkey-9b79a411e0d0ecd57c52f0878d2873f925eebc4f.zip | |
Use camelCase
Diffstat (limited to 'src/server/api/openapi')
| -rw-r--r-- | src/server/api/openapi/description.ts | 4 | ||||
| -rw-r--r-- | src/server/api/openapi/gen-spec.ts | 2 |
2 files changed, 3 insertions, 3 deletions
diff --git a/src/server/api/openapi/description.ts b/src/server/api/openapi/description.ts index 83250c3419..cc5f233c53 100644 --- a/src/server/api/openapi/description.ts +++ b/src/server/api/openapi/description.ts @@ -25,7 +25,7 @@ export const description = ` #### 2.ユーザーに認証させる アプリを使ってもらうには、ユーザーにアカウントへのアクセスの許可をもらう必要があります。 -認証セッションを開始するには、[${config.api_url}/auth/session/generate](#operation/auth/session/generate) へパラメータに appSecret としてシークレットキーを含めたリクエストを送信します。 +認証セッションを開始するには、[${config.apiUrl}/auth/session/generate](#operation/auth/session/generate) へパラメータに appSecret としてシークレットキーを含めたリクエストを送信します。 リクエスト形式はJSONで、メソッドはPOSTです。 レスポンスとして認証セッションのトークンや認証フォームのURLが取得できるので、認証フォームのURLをブラウザで表示し、ユーザーにフォームを提示してください。 @@ -35,7 +35,7 @@ export const description = ` あなたのアプリがコールバックURLを設定していない場合、ユーザーがあなたのアプリの連携を許可したことを(何らかの方法で(たとえばボタンを押させるなど))確認出来るようにしてください。 #### 3.ユーザートークンを取得する -ユーザーが連携を許可したら、[${config.api_url}/auth/session/userkey](#operation/auth/session/userkey) へリクエストを送信します。 +ユーザーが連携を許可したら、[${config.apiUrl}/auth/session/userkey](#operation/auth/session/userkey) へリクエストを送信します。 上手くいけば、認証したユーザーのユーザートークンがレスポンスとして取得できます。おめでとうございます！ diff --git a/src/server/api/openapi/gen-spec.ts b/src/server/api/openapi/gen-spec.ts index 7487918231..fd69569e6e 100644 --- a/src/server/api/openapi/gen-spec.ts +++ b/src/server/api/openapi/gen-spec.ts @@ -23,7 +23,7 @@ export function genOpenapiSpec(lang = 'ja-JP') { }, servers: [{ - url: config.api_url + url: config.apiUrl }], paths: {} as any, |