refactor: rename to API description for consistency (#1239)

Redocly · Sep 18, 2023 · 0a73f1f · 0a73f1f · github-actions · Sep 18, 2023
1 parent 680c431
commit 0a73f1f
Show file tree

Hide file tree

Showing 129 changed files with 273 additions and 282 deletions.
diff --git a/.changeset/three-moose-cheer.md b/.changeset/three-moose-cheer.md
@@ -0,0 +1,6 @@
+---
+'@redocly/openapi-core': patch
+'@redocly/cli': patch
+---
+
+Renamed API definition to API description for consistency.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -194,7 +194,7 @@ E2E tests are sensitive to any additional output (like `console.log`) in the sou
       - **`packages/core/src/types`**: contains the common types for several OpenAPI versions.
       - **`packages/core/src/typings`**: contains the common Typescript typings.
 
-- **`resources`**: contains some example API definitions and configuration files that might be useful for testing.
+- **`resources`**: contains some example API descriptions and configuration files that might be useful for testing.
 
 ## Release flow
 

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -26,9 +26,9 @@ Steps to reproduce the behavior:
 
 <!-- If applicable, add logs to help explain your problem. -->
 
-**OpenAPI definition**
+**OpenAPI description**
 
-<!-- If applicable, add an OpenAPI definition and `.redocly.yaml` configuration file that helps reproduce the problem.
+<!-- If applicable, add an OpenAPI description and `.redocly.yaml` configuration file that helps reproduce the problem.
 At a minimum, please state the specification version(s) you're using (e.g. 2.0, 3.0, 3.1). -->
 
 **Redocly Version(s)**

diff --git a/.github/styles/Vocab/Rules/accept.txt b/.github/styles/Vocab/Rules/accept.txt
@@ -124,6 +124,7 @@ OpenTracing
 Operator
 OperatorHub
 OpenAPI
+AsyncAPI
 osd
 PHP
 PostgreSQL

diff --git a/README.md b/README.md
@@ -30,8 +30,8 @@ redocly lint path-to-root-file.yaml
 
 ### Docker
 
-To give the Docker container access to the OpenAPI definition files, you need to
-mount the containing directory as a volume. Assuming the OAS definition is rooted
+To give the Docker container access to the OpenAPI description files, you need to
+mount the containing directory as a volume. Assuming the API description is rooted
 in the current working directory, you need the following command:
 
 ```
@@ -93,7 +93,7 @@ This tool [collects data](./docs/usage-data.md) to help Redocly improve our prod
 
 ## Credits
 
-Thanks to [graphql-js](https://github.com/graphql/graphql-js) and [eslint](https://github.com/eslint/eslint) for inspiration of the definition traversal approach and to [Swagger](https://github.com/swagger-api/swagger-editor), [Spectral](https://github.com/stoplightio/spectral), and [OAS-Kit](https://github.com/Mermade/oas-kit) for inspiring the recommended ruleset.
+Thanks to [graphql-js](https://github.com/graphql/graphql-js) and [eslint](https://github.com/eslint/eslint) for inspiration of the API description traversal approach and to [Swagger](https://github.com/swagger-api/swagger-editor), [Spectral](https://github.com/stoplightio/spectral), and [OAS-Kit](https://github.com/Mermade/oas-kit) for inspiring the recommended ruleset.
 
 ## Development
 

diff --git a/__tests__/lint-config/invalid-config--lint-config-error/snapshot.js b/__tests__/lint-config/invalid-config--lint-config-error/snapshot.js
@@ -19,7 +19,7 @@ Error was generated by the configuration spec rule.
 validating ../__fixtures__/valid-openapi.yaml...
 ../__fixtures__/valid-openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 [WARNING] Unused rules found in .redocly.yaml: context.
 Check the spelling and verify the added plugin prefix.

diff --git a/__tests__/lint-config/invalid-config--lint-config-off/snapshot.js b/__tests__/lint-config/invalid-config--lint-config-off/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint-config test with option: { dirName: 'invalid-config--lint-conf
 validating ../__fixtures__/valid-openapi.yaml...
 ../__fixtures__/valid-openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 [WARNING] Unused rules found in .redocly.yaml: context.
 Check the spelling and verify the added plugin prefix.

diff --git a/__tests__/lint-config/invalid-config--lint-config-warn/snapshot.js b/__tests__/lint-config/invalid-config--lint-config-warn/snapshot.js
@@ -19,7 +19,7 @@ You have 1 warning.
 validating ../__fixtures__/valid-openapi.yaml...
 ../__fixtures__/valid-openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 [WARNING] Unused rules found in .redocly.yaml: context.
 Check the spelling and verify the added plugin prefix.

diff --git a/__tests__/lint-config/invalid-config--no-option/snapshot.js b/__tests__/lint-config/invalid-config--no-option/snapshot.js
@@ -19,7 +19,7 @@ You have 1 warning.
 validating ../__fixtures__/valid-openapi.yaml...
 ../__fixtures__/valid-openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 [WARNING] Unused rules found in .redocly.yaml: context.
 Check the spelling and verify the added plugin prefix.

diff --git a/__tests__/lint-config/invalid-config-assertation-config-type/snapshot.js b/__tests__/lint-config/invalid-config-assertation-config-type/snapshot.js
@@ -22,7 +22,7 @@ The 'assert/' syntax in assert/path-item-mutually-required is deprecated. Update
 validating ../__fixtures__/valid-openapi.yaml...
 ../__fixtures__/valid-openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint-config/invalid-config-assertation-name/snapshot.js b/__tests__/lint-config/invalid-config-assertation-name/snapshot.js
@@ -20,7 +20,7 @@ Error was generated by the configuration spec rule.
 validating ../__fixtures__/valid-openapi.yaml...
 ../__fixtures__/valid-openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 [WARNING] Unused rules found in .redocly.yaml: asset/path-item-mutually-required.
 Check the spelling and verify the added plugin prefix.

diff --git a/__tests__/lint-config/invalid-config-format-json/snapshot.js b/__tests__/lint-config/invalid-config-format-json/snapshot.js
@@ -17,7 +17,7 @@ exports[`E2E lint-config test with option: {
 validating ../__fixtures__/valid-openapi.yaml...
 ../__fixtures__/valid-openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/assertions-camel-case-twice/snapshot.js b/__tests__/lint/assertions-camel-case-twice/snapshot.js
@@ -33,7 +33,7 @@ Warning was generated by the rule/named-parameters-camelCase rule.
 
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 You have 2 warnings.
 
 

diff --git a/__tests__/lint/assertions-non-empty-off/snapshot.js b/__tests__/lint/assertions-non-empty-off/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint assertions-non-empty-off 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/assertions-non-empty-warn/snapshot.js b/__tests__/lint/assertions-non-empty-warn/snapshot.js
@@ -19,7 +19,7 @@ Warning was generated by the rule/summary-non-empty rule.
 
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 You have 1 warning.
 
 

diff --git a/__tests__/lint/assertions-type-integer-in-schema-response/snapshot.js b/__tests__/lint/assertions-type-integer-in-schema-response/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint assertions-type-integer-in-schema-response 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/assertions/snapshot.js b/__tests__/lint/assertions/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint assertions 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/async2/snapshot.js b/__tests__/lint/async2/snapshot.js
@@ -50,7 +50,7 @@ validating /streetlights-operation-security.yml...
 validating /websocket-gemini.yml...
 /websocket-gemini.yml: validated in <test>ms
 
-Woohoo! Your OpenAPI definitions are valid. 🎉
+Woohoo! Your API descriptions are valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/deprecated-apiDefinitions/snapshot.js b/__tests__/lint/deprecated-apiDefinitions/snapshot.js
@@ -49,7 +49,7 @@ Warning was generated by the info-contact rule.
 
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 You have 1 warning.
 
 

diff --git a/__tests__/lint/info-contact--lint-in-apis/snapshot.js b/__tests__/lint/info-contact--lint-in-apis/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint info-contact--lint-in-apis 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/info-contact-not-present-warning/snapshot.js b/__tests__/lint/info-contact-not-present-warning/snapshot.js
@@ -18,7 +18,7 @@ Warning was generated by the info-contact rule.
 
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 You have 1 warning.
 
 

diff --git a/__tests__/lint/info-contact/snapshot.js b/__tests__/lint/info-contact/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint info-contact 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/info-license-rule-not-present-warning/snapshot.js b/__tests__/lint/info-license-rule-not-present-warning/snapshot.js
@@ -18,7 +18,7 @@ Warning was generated by the info-license rule.
 
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 You have 1 warning.
 
 

diff --git a/__tests__/lint/info-license-rule/snapshot.js b/__tests__/lint/info-license-rule/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint info-license-rule 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/info-license-url-missing-warning/snapshot.js b/__tests__/lint/info-license-url-missing-warning/snapshot.js
@@ -19,7 +19,7 @@ Warning was generated by the info-license-url rule.
 
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 You have 1 warning.
 
 

diff --git a/__tests__/lint/info-license-url-rule/snapshot.js b/__tests__/lint/info-license-url-rule/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint info-license-url-rule 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/merge-lint-configs/snapshot.js b/__tests__/lint/merge-lint-configs/snapshot.js
@@ -18,7 +18,7 @@ Warning was generated by the info-contact rule.
 
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 You have 1 warning.
 
 

diff --git a/__tests__/lint/no-empty-servers-rule/snapshot.js b/__tests__/lint/no-empty-servers-rule/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint no-empty-servers-rule 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/no-empty-servers-warning/snapshot.js b/__tests__/lint/no-empty-servers-warning/snapshot.js
@@ -19,7 +19,7 @@ Warning was generated by the no-empty-servers rule.
 
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 You have 1 warning.
 
 

diff --git a/__tests__/lint/no-enum-type-mismatch/snapshot.js b/__tests__/lint/no-enum-type-mismatch/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint no-enum-type-mismatch 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/no-invalid-media-type-examples-recursion-oneOf/snapshot.js b/__tests__/lint/no-invalid-media-type-examples-recursion-oneOf/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint no-invalid-media-type-examples-recursion-oneOf 1`] = `
 validating /openapi.json...
 /openapi.json: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/no-invalid-media-type-examples-recursion/snapshot.js b/__tests__/lint/no-invalid-media-type-examples-recursion/snapshot.js
@@ -42,7 +42,7 @@ Warning was generated by the no-invalid-media-type-examples rule.
 
 /openapi.json: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 You have 2 warnings.
 
 

diff --git a/__tests__/lint/no-invalid-schema-examples-oas3.1/snapshot.js b/__tests__/lint/no-invalid-schema-examples-oas3.1/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint no-invalid-schema-examples-oas3.1 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/no-invalid-schema-examples/snapshot.js b/__tests__/lint/no-invalid-schema-examples/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint no-invalid-schema-examples 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/no-path-trailing-slash-off/snapshot.js b/__tests__/lint/no-path-trailing-slash-off/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint no-path-trailing-slash-off 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/no-path-trailing-slash-rule/snapshot.js b/__tests__/lint/no-path-trailing-slash-rule/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint no-path-trailing-slash-rule 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/no-server-example-rule/snapshot.js b/__tests__/lint/no-server-example-rule/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint no-server-example-rule 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/no-server-trailing-slash-rule/snapshot.js b/__tests__/lint/no-server-trailing-slash-rule/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint no-server-trailing-slash-rule 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/no-server-variables-empty-enum/snapshot.js b/__tests__/lint/no-server-variables-empty-enum/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint no-server-variables-empty-enum 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/no-unresolved-refs-rule/snapshot.js b/__tests__/lint/no-unresolved-refs-rule/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint no-unresolved-refs-rule 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/no-unused-components-rule/snapshot.js b/__tests__/lint/no-unused-components-rule/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint no-unused-components-rule 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
diff --git a/__tests__/lint/no-unused-components-warning/snapshot.js b/__tests__/lint/no-unused-components-warning/snapshot.js
@@ -19,7 +19,7 @@ Warning was generated by the no-unused-components rule.
 
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 You have 1 warning.
 
 

diff --git a/__tests__/lint/oas2/snapshot.js b/__tests__/lint/oas2/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E lint oas2 1`] = `
 validating /openapi.yaml...
 /openapi.yaml: validated in <test>ms
 
-Woohoo! Your OpenAPI definition is valid. 🎉
+Woohoo! Your API description is valid. 🎉
 
 
 `;
St.^❔	Category	Percentage	Covered / Total
🟡	Statements	75.88%	3995/5265
🟡	Branches	65.8%	2128/3234
🟡	Functions	68%	648/953
🟡	Lines	76.07%	3745/4923