Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update "Validating OpenAPI and JSON Schema" post #704

Merged
merged 1 commit into from
May 24, 2024
Merged

Update "Validating OpenAPI and JSON Schema" post #704

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 17 additions & 26 deletions pages/blog/posts/validating-openapi-and-json-schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,42 +65,33 @@ any dialect you choose to use in your OpenAPI 3.1 documents.

### Examples

These examples use the [@hyperjump/oas-schema-validator](https://www.npmjs.com/package/@hyperjump/oas-schema-validator)
to validate OpenAPI documents. It's just an extension of [@hyperjump/json-schema](https://www.npmjs.com/package/@hyperjump/json-schema)
with support for the OpenAPI 3.1 dialect and all the OpenAPI 3.1 schemas
pre-packaged. Beware that dynamic references are a new feature of JSON Schema
and many validators don't yet support them, or have limited support, or have
bugs.
These examples use
[@hyperjump/json-schema](https://www.npmjs.com/package/@hyperjump/json-schema)
to validate OpenAPI documents. Beware that dynamic references are a relatively
new feature of JSON Schema and many validators don't yet support them, or have
limited support, or have bugs.

#### Without schema validation
```javascript
const OasSchema = require("@hyperjump/oas-schema-validator");
const example = require("./example.openapi.json");
import { validate } from "@hyperjump/json-schema/openapi-3-1";

(async function () {
const schema = await OasSchema.get(
"https://spec.openapis.org/oas/3.1/schema"
);
const validate = await OasSchema.validate(schema);
const validateOpenApi = await validate("https://spec.openapis.org/oas/3.1/schema");

const result = validate(example);
console.log(result.valid);
}());
const example = YAML.parse(await readFile("./example.openapi.json"));
const result = validateOpenApi(example);
console.log(result);
```

#### With OpenAPI Schema dialect schema validation
```javascript
const OasSchema = require("@hyperjump/oas-schema-validator");
const example = require("./example.openapi.json");
import { validate } from "@hyperjump/json-schema/openapi-3-1";

(async function () {
const schema = await OasSchema.get(
"https://spec.openapis.org/oas/3.1/schema-base"
);
const validate = await OasSchema.validate(schema);
const validateOpenApi = await validate("https://spec.openapis.org/oas/3.1/schema-base");

const result = validate(example);
console.log(result.valid);
const example = YAML.parse(await readFile("./example.openapi.json"));
const result = validateOpenApi(example);
console.log(result);
}());
```

Expand Down Expand Up @@ -151,7 +142,7 @@ The first step is to include the abstract schema.
```yaml
$schema: 'https://json-schema.org/draft/2020-12/schema'

$ref: 'https://spec.openapis.org/oas/3.1/schema/2021-09-28'
$ref: 'https://spec.openapis.org/oas/3.1/schema/latest'
```

Then we need to add a `$dynamicAnchor` that matches the one in the abstract
Expand All @@ -161,7 +152,7 @@ there we can reference the meta schema for the default dialect.
```yaml
$schema: 'https://json-schema.org/draft/2020-12/schema'

$ref: 'https://spec.openapis.org/oas/3.1/schema/2021-09-28'
$ref: 'https://spec.openapis.org/oas/3.1/schema/latest'

$defs:
schema:
Expand Down
Loading