Fixing references to OpenAPI #355
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Now should align with the guidelines in the OpenAPI style guide reference here: https://github.com/OAI/OpenAPI-Style-Guide
|
Thanks for the updates! |
|
Yes, but these 'fixes' are only for the first main page - what about all the .md files? If you feel passionate about this, could please fix these as well? Thanks! |
PatGod
reviewed
Sep 28, 2021
| 1. **Compile:** from a Swagger JSON or YAML specification (and optionally examples), generate a RESTler grammar. See [Compiling](./docs/user-guide/Compiling.md). | ||
| 2. **Test:** execute quickly all of the endpoints+methods in a compiled RESTler grammar for debugging the test setup and compute what parts of the Swagger spec are covered. This mode is also called a *smoketest*. | ||
| 1. **Compile:** from an OpenAPI document in either JSON or YAML format (and optionally examples), generate a RESTler grammar. See [Compiling](./docs/user-guide/Compiling.md). | ||
| 2. **Test:** execute quickly all of the endpoints+methods in a compiled RESTler grammar for debugging the test setup and compute what parts of the OpenAPI Specification are covered. This mode is also called a *smoketest*. | ||
| See [Testing](./docs/user-guide/Testing.md). To use custom test engine settings, see [Test Engine Settings](./docs/user-guide/SettingsFile.md). |
There was a problem hiding this comment.
there should not be an upper case to 'Specification' here.
| @@ -66,8 +66,8 @@ Prerequisites: Install [Python 3.8.2](https://www.python.org/downloads/) and | |||
|
|
|||
| RESTler runs in 4 main modes (in order): | |||
|
|
|||
| 1. **Compile:** from a Swagger JSON or YAML specification (and optionally examples), generate a RESTler grammar. See [Compiling](./docs/user-guide/Compiling.md). | |||
| 2. **Test:** execute quickly all of the endpoints+methods in a compiled RESTler grammar for debugging the test setup and compute what parts of the Swagger spec are covered. This mode is also called a *smoketest*. | |||
| 1. **Compile:** from an OpenAPI document in either JSON or YAML format (and optionally examples), generate a RESTler grammar. See [Compiling](./docs/user-guide/Compiling.md). | |||
There was a problem hiding this comment.
please replace 'document' by 'specification' for consistency
| RESTler intelligently infers producer-consumer dependencies among request types from the Swagger | ||
| specification. During testing, it checks for specific classes of bugs | ||
| RESTler intelligently infers producer-consumer dependencies among request types from the OpenAPI | ||
| document. During testing, it checks for specific classes of bugs |
There was a problem hiding this comment.
please replace 'document' by 'specification' for consistency
| @@ -91,7 +91,7 @@ When a bug is found, RESTler reports bugs triaged in bug buckets, and provides a | |||
|
|
|||
| ## Advanced Topics | |||
|
|
|||
| For tips on using RESTler effectively, please see [Best Practices](./docs/user-guide/BestPractices.md) and [Improving Swagger Coverage](./docs/user-guide/ImprovingCoverage.md). | |||
| For tips on using RESTler effectively, please see [Best Practices](./docs/user-guide/BestPractices.md) and [Improving OpenAPI Coverage](./docs/user-guide/ImprovingCoverage.md). | |||
There was a problem hiding this comment.
'OpenAPI' should really be 'API' here.
|
PS: feel free to merge and I can clean this up later. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Now should align with the guidelines in the OpenAPI style guide reference here: https://github.com/OAI/OpenAPI-Style-Guide