chore(routes/docs): use correct terminology for openapi definitions (#…

…1276)
Fdawgs · Feb 28, 2023 · 08e302a · 08e302a
1 parent f2d35e4
commit 08e302a
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -107,6 +107,8 @@ API documentation can be found at `/docs`:
 
 <img alttext="Screenshot of Docsmith documentation page" src="https://raw.githubusercontent.com/Fdawgs/docsmith/main/docs/images/api_documentation_screenshot.png" width="720">
 
+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
@@ -2,7 +2,7 @@
 <html lang="en">
 	<head>
 		<meta charset="utf-8" />
-		<meta name="description" content="Reference documentation and OpenAPI specification for Docsmith." />
+		<meta name="description" content="Reference documentation and OpenAPI definitions for Docsmith." />
 		<meta name="author" content="Frazer Smith" />
 		<meta name="viewport" content="width=device-width, initial-scale=1" />
 

diff --git 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
@@ -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
@@ -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