Skip to content

Commit 007ac3d

Browse files
committed
docs(rules): augment status
Provide link to CHANGELOG version where a rule was implemented
1 parent caf7744 commit 007ac3d

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/rules/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
88
| `options` | Rule | Description| Status |
99
|:----------------:|:-----|:-----------|:-------|
10-
| | [`no-dup-paths`][no-dup-paths-url] | Each API `path` should be unique. | Completed |
11-
| | [`no-path-verbs`][no-path-verbs-url] | Prohibit verbs in api paths | Completed |
12-
| :wrench: | [`require-plural-paths`][require-plural-paths-url] | Require plural nouns in API paths | Completed |
10+
| | [`no-dup-paths`][no-dup-paths-url] | Each API `path` should be unique. | Completed in [`v0.1.0`][changelog-v0.1.0-url] |
11+
| | [`no-path-verbs`][no-path-verbs-url] | Prohibit verbs in api paths | Completed in [`v0.1.0`][changelog-v0.1.0-url] |
12+
| :wrench: | [`require-plural-paths`][require-plural-paths-url] | Require plural nouns in API paths | Completed in [`v0.1.0`][changelog-v0.1.0-url] |
1313

1414
## Rules in backlog
1515

@@ -46,6 +46,7 @@ The product backlog has lots of lonely `rules` looking for love from nice contri
4646
| | [`require-default-value`](https://github.com/gregswindle/eslint-plugin-swagger/issues/new?title=feat%28require-default-value%29%3A%20Every%20place%20where%20a%20default...&labels[]=ESLint%3A%20Rule&labels[]=Status%3A%20Available&labels[]=Type%3A%20Feature&labels[]=Type%3A%20Docs) | Every place where a default value can be provided, the default value must validate against the corresponding schema/definition. _(This is not handled by JSON Schema validators, at least not the one I am using, so we have to do this manually. See [json-schema/JSON-Schema-Test-Suite/pull/67](https://github.com/json-schema/JSON-Schema-Test-Suite/pull/67))_ | Available |
4747
| | [`require-path-definition`](https://github.com/gregswindle/eslint-plugin-swagger/issues/new?title=feat%28require-path-definition%29%3A%20For%20each%20API%20path%20parameter...&labels[]=ESLint%3A%20Rule&labels[]=Status%3A%20Available&labels[]=Type%3A%20Feature&labels[]=Type%3A%20Docs) | For each API path parameter, all operations for the API path require corresponding path parameter definitions or the corresponding path parameter needs to be in the path's parameters. | Available |
4848

49+
[changelog-v0.1.0-url]: ../../CHANGELOG.md#0.1.0
4950
[code-of-conduct-url]: ./.github/CODE_OF_CONDUCT.md
5051
[eslint-dev-env-url]: http://eslint.org/docs/developer-guide/development-environment
5152
[no-dup-paths-url]: ./no-dup-paths.md

0 commit comments

Comments
 (0)