lint/.automation/test/openapi/README.md

21 lines
712 B
Markdown
Raw Normal View History

2020-06-25 02:13:19 -04:00
# OpenAPI Test Cases
2020-07-21 13:08:05 -04:00
This folder holds the test cases for **OpenAPI**.
2020-06-25 02:13:19 -04:00
## Additional Docs
2020-07-21 13:08:05 -04:00
The `_bad_` tests are valid `.yml`/`.json` but invalid OpenAPI specs.
The test extensions used are `.ymlopenapi`/`.jsonopenapi` instead of `.yml`/`.json`. This is to prevent the [YAML] and [JSON] tests from picking them up.
2020-06-25 02:13:19 -04:00
## Good Test Cases
2020-07-21 13:08:05 -04:00
2020-06-25 02:13:19 -04:00
The test cases denoted: `LANGUAGE_good_FILE.EXTENSION` are all valid, and should pass successfully when linted.
2020-07-21 13:08:05 -04:00
2020-06-25 02:13:19 -04:00
- **Note:** They are linted utilizing the default linter rules.
## Bad Test Cases
2020-07-21 13:08:05 -04:00
2020-06-25 02:13:19 -04:00
The test cases denoted: `LANGUAGE_bad_FILE.EXTENSION` are **NOT** valid, and should trigger errors when linted.
2020-07-21 13:08:05 -04:00
2020-06-25 02:13:19 -04:00
- **Note:** They are linted utilizing the default linter rules.