diff --git a/README.md b/README.md index 409f59b43..514ea9de2 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,8 @@ API documentation can be found at `/docs`: +The underlying OpenAPI definitions are found at `/docs/openapi`. + ## Contributing Contributions are welcome, and any help is greatly appreciated! diff --git a/src/routes/docs/index.html b/src/routes/docs/index.html index 320a46a99..90a28557d 100644 --- a/src/routes/docs/index.html +++ b/src/routes/docs/index.html @@ -2,7 +2,7 @@ - + diff --git a/src/routes/docs/openapi/route.test.js b/src/routes/docs/openapi/route.test.js index cbed591fa..6dce01e3e 100644 --- a/src/routes/docs/openapi/route.test.js +++ b/src/routes/docs/openapi/route.test.js @@ -28,7 +28,7 @@ describe("OpenAPI route", () => { await server.close(); }); - test("Should return OpenAPI specification", async () => { + test("Should return OpenAPI definitions", async () => { const response = await server.inject({ method: "GET", url: "/", diff --git a/src/routes/docs/openapi/schema.js b/src/routes/docs/openapi/schema.js index 5adcb7b3a..702f464bf 100644 --- a/src/routes/docs/openapi/schema.js +++ b/src/routes/docs/openapi/schema.js @@ -8,8 +8,8 @@ const S = require("fluent-json-schema"); */ const docsOpenapiGetSchema = { hide: true, - summary: "List OpenAPI specification", - description: "Retrieves OpenAPI specification.", + summary: "List OpenAPI definitions", + description: "Retrieves OpenAPI definitions.", operationId: "getDocsOpenapi", produces: ["application/json", "application/xml"], response: { diff --git a/src/server.js b/src/server.js index 7d06dfa2a..3abf1dfa9 100644 --- a/src/server.js +++ b/src/server.js @@ -57,7 +57,7 @@ async function plugin(server, config) { // Reusable schemas .register(sharedSchemas) - // Generate OpenAPI/Swagger schemas + // Generate OpenAPI/Swagger definitions .register(swagger, config.swagger) // Process load and 503 response handling