Skip to content

Commit d3c93ea

Browse files
committed
update recommended and spec
1 parent 0df3a95 commit d3c93ea

File tree

4 files changed

+30
-11
lines changed

4 files changed

+30
-11
lines changed

__tests__/lint/oas3.1/openapi.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ paths:
3434
schema:
3535
type: array
3636
prefixItems:
37-
- type: 'string'
37+
- type: string
3838
items: false
3939
400:
4040
description: An error response
@@ -109,10 +109,10 @@ paths:
109109
/unevaluated-properties:
110110
get:
111111
operationId: getUnevaluatedProperties
112-
summary: Checks if unevaluetedProperties work
112+
summary: Checks if unevaluatedProperties work
113113
responses:
114114
200:
115-
description: 'OK'
115+
description: OK
116116
content:
117117
application/json:
118118
schema:
@@ -177,11 +177,11 @@ components:
177177
pathItems: {}
178178
schemas:
179179
Problem:
180-
id: 'https://tools.ietf.org/rfc/rfc7807.txt'
180+
id: https://tools.ietf.org/rfc/rfc7807.txt
181181
$schema: 'http://json-schema.org/draft-06/schema#'
182-
description: 'schema for a rfc7807'
182+
description: schema for a rfc7807
183183
definitions: {}
184-
type: 'object'
184+
type: object
185185
properties:
186186
type:
187187
description: A URI reference [RFC3986] that identifies the problem type.

__tests__/lint/oas3.1/snapshot.txt

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,33 @@
1-
[1] openapi.yaml:179:5 at #/components/schemas/Problem
1+
[1] openapi.yaml:180:7 at #/components/schemas/Problem/schema
2+
3+
Example validation errored: NOT SUPPORTED: keyword "id", use "$id" for schema ID.
4+
5+
178 | schemas:
6+
179 | Problem:
7+
180 | id: https://tools.ietf.org/rfc/rfc7807.txt
8+
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9+
181 | $schema: 'http://json-schema.org/draft-06/schema#'
10+
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11+
… | < 32 more lines >
12+
214 | Pet:
13+
| ^
14+
215 | required:
15+
216 | - id
16+
17+
referenced from openapi.yaml:180:7 at #/components/schemas/Problem
18+
19+
Warning was generated by the no-invalid-schema-examples rule.
20+
21+
22+
[2] openapi.yaml:179:5 at #/components/schemas/Problem
223

324
Component: "Problem" is never used.
425

526
177 | pathItems: {}
627
178 | schemas:
728
179 | Problem:
829
| ^^^^^^^
9-
180 | id: 'https://tools.ietf.org/rfc/rfc7807.txt'
30+
180 | id: https://tools.ietf.org/rfc/rfc7807.txt
1031
181 | $schema: 'http://json-schema.org/draft-06/schema#'
1132

1233
Warning was generated by the no-unused-components rule.
@@ -17,5 +38,5 @@ validating openapi.yaml using lint rules for api 'main'...
1738
openapi.yaml: validated in <test>ms
1839

1940
Woohoo! Your API description is valid. 🎉
20-
You have 1 warning.
41+
You have 2 warnings.
2142

docs/@v2/rules/recommended.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ Errors:
2727
- [path-declaration-must-exist](./oas/path-declaration-must-exist.md)
2828
- [path-not-include-query](./oas/path-not-include-query.md)
2929
- [path-parameters-defined](./oas/path-parameters-defined.md)
30-
- [path-params-defined](./oas/path-parameters-defined.md)
3130
- [security-defined](./oas/security-defined.md)
3231
- [sourceDescription-name-unique](./arazzo/sourceDescriptions-name-unique.md)
3332
- [sourceDescription-type](./arazzo/sourceDescriptions-type.md)

docs/@v2/rules/spec-ruleset.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ All the rules are of severity `error`:
2121
- [path-declaration-must-exist](./oas/path-declaration-must-exist.md)
2222
- [path-not-include-query](./oas/path-not-include-query.md)
2323
- [path-parameters-defined](./oas/path-parameters-defined.md)
24-
- [path-params-defined](./oas/path-parameters-defined.md)
2524
- [requestBody-replacements-unique](./arazzo/requestBody-replacements-unique.md)
2625
- [sourceDescription-name-unique](./arazzo/sourceDescriptions-name-unique.md)
2726
- [sourceDescription-type](./arazzo/sourceDescriptions-type.md)

0 commit comments

Comments
 (0)