Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/rulesets/src/arazzo/schemas/validators.ts

Large diffs are not rendered by default.

29 changes: 29 additions & 0 deletions packages/rulesets/src/oas/__tests__/oas3-schema.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -580,4 +580,33 @@ testRule('oas3-schema', [
},
errors: [],
},
{
name: 'oas3.1: document with external references',
document: {
openapi: '3.1.0',
info: {
title: 'Example API',
version: '1.0.0',
description: 'Example API description',
},
paths: {
'/greetings': {
$ref: 'greetings.yaml',
},
},
tags: [
{
name: 'User',
description: 'Info about users',
},
],
servers: [
{
url: 'https://example-url.com',
description: 'Example server',
},
],
},
errors: [], // No errors expected
},
]);
2 changes: 1 addition & 1 deletion packages/rulesets/src/oas/schemas/oas/v3.1/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@
"type": "object",
"patternProperties": {
"^/": {
"$ref": "#/$defs/path-item"
"$ref": "#/$defs/path-item-or-reference"
}
},
"$ref": "#/$defs/specification-extensions",
Expand Down
40 changes: 40 additions & 0 deletions test-harness/scenarios/oas3.1/external-ref.scenario
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
====test====
OAS 3.1 - External Ref Validation
====document====
openapi: 3.1.0
info:
title: Example API
version: 1.0.0
description: Example API description
paths:
/greetings:
$ref: "greetings.yaml"
tags:
- name: User
description: Info about users
servers:
- url: https://example-url.com
description: Example server
====asset:greetings.yaml====
get:
description: Get a greeting
operationId: getGreeting
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Hello there!
====asset:ruleset.yaml====
extends: [[spectral:oas, off]]
rules:
oas3-schema: error
====command====
{bin} lint {document} --ruleset {asset:ruleset.yaml}
====stdout====
No results with a severity of 'error' found!