Add schema stub and schema tests

scripts/validate.mjs

@@ -0,0 +1,52 @@
+#!/usr/bin/env node
+
+import { readFile } from "node:fs/promises";
+import YAML from "yaml";
+import { setMetaSchemaOutputFormat, validate } from "@hyperjump/json-schema/draft-2020-12";
+import { BASIC } from "@hyperjump/json-schema/experimental";
+
+import contentTypeParser from "content-type";
+import { addMediaTypePlugin } from "@hyperjump/browser";
+import { buildSchemaDocument } from "@hyperjump/json-schema/experimental";
+
+addMediaTypePlugin("application/schema+yaml", {
+    parse: async (response) => {
+      const contentType = contentTypeParser.parse(response.headers.get("content-type") ?? "");
+      const contextDialectId = contentType.parameters.schema ?? contentType.parameters.profile;
+
+      const foo = YAML.parse(await response.text());
+      return buildSchemaDocument(foo, response.url, contextDialectId);
+    },
+    fileMatcher: (path) => path.endsWith(".yaml")
+  });
+
+const defaultOutputFormat = BASIC;
+
+if (process.argv.length < 3) {
+  console.log(`Usage: validate [--schema=schema] [--format=${defaultOutputFormat}] path-to-file.yaml`);
+  console.log("\t--schema: (schema (default) | schema-base) The name of the schema file to use");
+  console.log(`\t--format: (Default: ${defaultOutputFormat}) The JSON Schema output format to use. Options: FLAG, BASIC, DETAILED, VERBOSE`);
+  process.exit(1);
+}
+
+const args = process.argv.reduce((acc, arg) => {
+  if (!arg.startsWith("--")) return acc;
+
+  const [argName, argValue] = arg.substring(2).split("=", 2);
+  return { ...acc, [argName]: argValue };
+}, {});
+
+const schemaType = args.schema || "schema";
+const outputFormat = args.format || defaultOutputFormat;
+
+// Config
+setMetaSchemaOutputFormat(outputFormat);
+
+// Compile / meta-validate
+const validateOpenApi = await validate(`./schemas/v1.0/${schemaType}.yaml`);
+
+// Validate instance
+const instanceYaml = await readFile(`${process.argv[process.argv.length - 1]}`, "utf8");
+const instance = YAML.parse(instanceYaml);
+const results = validateOpenApi(instance, outputFormat);
+console.log(JSON.stringify(results, null, "  "));

tests/v1.0/pass/array-modification-example-remove.yaml

@@ -0,0 +1,9 @@
+overlay: 1.0.0
+info:
+  title: Add an array element
+  version: 1.0.0
+actions:
+  - target: $.paths.*.get.parameters
+    update:
+      name: newParam
+      in: query

tests/v1.0/pass/array-modification-example-update.yaml

@@ -0,0 +1,7 @@
+overlay: 1.0.0
+info:
+  title: Remove a array element
+  version: 1.0.0
+actions:
+  - target: $.paths.*.get.parameters[?@.name == 'dummy']
+    remove: true

tests/v1.0/pass/structured-overlay-example.yaml

@@ -0,0 +1,21 @@
+overlay: 1.0.0
+info:
+  title: Structured Overlay
+  version: 1.0.0
+actions:
+  - target: '$' # Root of document
+    update:
+      info:
+        x-overlay-applied: structured-overlay
+      paths:
+        '/':
+          summary: 'The root resource'
+          get:
+            summary: 'Retrieve the root resource'
+            x-rate-limit: 100
+        '/pets':
+          get:
+            summary: 'Retrieve a list of pets'
+            x-rate-limit: 100
+      components:
+      tags:

tests/v1.0/pass/targeted-overlay-example.yaml

@@ -0,0 +1,16 @@
+overlay: 1.0.0
+info:
+  title: Targeted Overlay
+  version: 1.0.0
+actions:
+  - target: $.paths['/foo'].get
+    update:
+      description: This is the new description
+  - target: $.paths['/bar'].get
+    update:
+      description: This is the updated description
+  - target: $.paths['/bar']
+    update:
+      post:
+        description: This is an updated description of a child object
+        x-safe: false

tests/v1.0/pass/traits-example.yaml

@@ -0,0 +1,14 @@
+overlay: 1.0.0
+info:
+  title: Apply Traits
+  version: 1.0.0
+actions:
+  - target: $.paths.*.get[?@.x-oai-traits.paged]
+    update:
+      parameters:
+        - name: top
+          in: query
+          # ...
+        - name: skip
+          in: query
+          # ...

tests/v1.0/pass/wildcard-overlay-example.yaml

@@ -0,0 +1,12 @@
+overlay: 1.0.0
+info:
+  title: Update many objects at once
+  version: 1.0.0
+actions:
+  - target: $.paths.*.get
+    update:
+      x-safe: true
+  - target: $.paths.*.get.parameters[?@.name=='filter' && @.in=='query']
+    update:
+      schema:
+        $ref: '/components/schemas/filterSchema'