From 75d6cf68e0e2e170ffc4db239a8648db2aeb0ae2 Mon Sep 17 00:00:00 2001 From: Kevin Hinterlong Date: Wed, 4 Dec 2024 16:52:25 -0600 Subject: [PATCH] fix: use openapi.json instead of default swagger.json in api docs (#619) --- docs/ja/user-guide/api.md | 6 +++--- docs/user-guide/api.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/ja/user-guide/api.md b/docs/ja/user-guide/api.md index 6f9f0e23..c2807a6f 100644 --- a/docs/ja/user-guide/api.md +++ b/docs/ja/user-guide/api.md @@ -39,7 +39,7 @@ ScrewdriverのAPIとデータモデルは[Swagger](http://swagger.io/)を使っ > 現在のAPIは**Version 4**で、全てのAPIは`/v4`で始まります。 -APIのドキュメントは次のURLで確認できます: [api.screwdriver.cd/v4/documentation](https://api.screwdriver.cd/v4/documentation) +APIのドキュメントは次のURLで確認できます: [api.screwdriver.cd/v4/documentation](https://api.screwdriver.cd/v4/documentation?url=/v4/openapi.json) 各自のScrewdriver.cdインスタンスでは、`/v4/documentation`にアクセスしてください。 @@ -163,6 +163,6 @@ APIでは、リクエストごとのペイロードサイズが最大1MBに制 ## 自作する Swaggerドキュメントを作成したい場合は、次のJSONを参考にしてください: - [https://api.screwdriver.cd/v4/swagger.json](https://api.screwdriver.cd/v4/swagger.json) + [https://api.screwdriver.cd/v4/openapi.json](https://api.screwdriver.cd/v4/openapi.json) -各自のScrewdriver.cdインスタンスでは、`/v4/swagger.json` にアクセスしてください。 +各自のScrewdriver.cdインスタンスでは、`/v4/openapi.json` にアクセスしてください。 diff --git a/docs/user-guide/api.md b/docs/user-guide/api.md index 8b395e52..0b691f55 100644 --- a/docs/user-guide/api.md +++ b/docs/user-guide/api.md @@ -39,7 +39,7 @@ Screwdriver APIs and the data models around them are documented via [Swagger]. T > **Version 4** is the current API, all links should be prefixed with `/v4`. -Our API documentation can be found at [api.screwdriver.cd/v4/documentation](https://api.screwdriver.cd/v4/documentation). To see yours, go to `/v4/documentation`. +Our API documentation can be found at [api.screwdriver.cd/v4/documentation](https://api.screwdriver.cd/v4/documentation?url=/v4/openapi.json). To see yours, go to `/v4/documentation`. ## Using the API @@ -170,7 +170,7 @@ The API enforces a maximum payload size of 1 MB per request. This limitation is ## Make Your Own -If you'd like to make your own Swagger documentation, check out our JSON for reference at [https://api.screwdriver.cd/v4/swagger.json](https://api.screwdriver.cd/v4/swagger.json). To see your Swagger.json, visit `/v4/swagger.json`. +If you'd like to make your own Swagger documentation, check out our JSON for reference at [https://api.screwdriver.cd/v4/openapi.json](https://api.screwdriver.cd/v4/openapi.json). To see your Swagger.json, visit `/v4/openapi.json`. [JSON Web Tokens]: http://jwt.io [GitHub OAuth]: https://docs.github.com/en/developers/apps/building-oauth-apps/authorizing-oauth-apps