ci: sets up testing infra for 1.1 version

schemas/v1.1/schema.yaml

@@ -0,0 +1,70 @@
+$id: https://spec.openapis.org/overlay/1.1/schema/WORK-IN-PROGRESS
+$schema: https://json-schema.org/draft/2020-12/schema
+description: The description of Overlay v1.1.x documents
+type: object
+properties:
+  overlay:
+    type: string
+    pattern: ^1\.1\.\d+$
+  info:
+    $ref: "#/$defs/info-object"
+  extends:
+    type: string
+    format: uri-reference
+  actions:
+    type: array
+    minItems: 1
+    uniqueItems: true
+    items:
+      $ref: "#/$defs/action-object"
+required:
+  - overlay
+  - info
+  - actions
+$ref: "#/$defs/specification-extensions"
+unevaluatedProperties: false
+$defs:
+  info-object:
+    type: object
+    properties:
+      title:
+        type: string
+      version:
+        type: string
+    required:
+      - title
+      - version
+    $ref: "#/$defs/specification-extensions"
+    unevaluatedProperties: false
+  action-object:
+    properties:
+      target:
+        type: string
+        pattern: ^\$
+      description:
+        type: string
+    oneOf:
+      - properties:
+          update:
+            type:
+              - string
+              - boolean
+              - object
+              - array
+              - number
+              - "null"
+        required:
+          - update
+      - properties:
+          remove:
+            type: boolean
+            default: false
+        required:
+          - remove
+    required:
+      - target
+    $ref: "#/$defs/specification-extensions"
+    unevaluatedProperties: false
+  specification-extensions:
+    patternProperties:
+      ^x-: true

scripts/validate.mjs

@@ -38,12 +38,13 @@ const args = process.argv.reduce((acc, arg) => {
 
 const schemaType = args.schema || "schema";
 const outputFormat = args.format || defaultOutputFormat;
+const version = args.version || "1.0";
 
 // Config
 setMetaSchemaOutputFormat(outputFormat);
 
 // Compile / meta-validate
-const validateOverlay = await validate(`./schemas/v1.0/${schemaType}.yaml`);
+const validateOverlay = await validate(`./schemas/v${version}/${schemaType}.yaml`);
 
 // Validate instance
 const instanceYaml = await readFile(`${process.argv[process.argv.length - 1]}`, "utf8");

tests/v1.0/schema.test.mjs → tests/schema.test.mjs

@@ -30,38 +30,38 @@ const parseYamlFromFile = (filePath) => {
   return YAML.parse(schemaYaml, { prettyErrors: true });
 };
 
+const runTestSuite = (version, validateOverlay, suite = "pass") => {
+  readdirSync(`./tests/v${version}/${suite}`, { withFileTypes: true })
+    .filter((entry) => entry.isFile() && /\.yaml$/.test(entry.name))
+    .forEach((entry) => {
+      test(entry.name, () => {
+        const instance = parseYamlFromFile(`./tests/v${version}/${suite}/${entry.name}`);
+        const output = validateOverlay(instance, BASIC);
+        if (suite === "pass")
+          expect(output).to.deep.equal({ valid: true });
+        else
+          expect(output.valid).to.equal(false);
+      });
+    });
+}
+
 setMetaSchemaOutputFormat(BASIC);
 
-let validateOverlay;
-try {
-  validateOverlay = await validate("./schemas/v1.0/schema.yaml");
-} catch (error) {
-  console.error(error.output);
-  process.exit(1);
-}
+const versions = ["1.0", "1.1"];
 
-describe("v1.0", () => {
+describe.each(versions)("v%s", async (version) => {
+  let validateOverlay;
+  try {
+    validateOverlay = await validate(`./schemas/v${version}/schema.yaml`);
+  } catch (error) {
+    console.error(error.output);
+    process.exit(1);
+  }
   describe("Pass", () => {
-    readdirSync(`./tests/v1.0/pass`, { withFileTypes: true })
-      .filter((entry) => entry.isFile() && /\.yaml$/.test(entry.name))
-      .forEach((entry) => {
-        test(entry.name, () => {
-          const instance = parseYamlFromFile(`./tests/v1.0/pass/${entry.name}`);
-          const output = validateOverlay(instance, BASIC);
-          expect(output).to.deep.equal({ valid: true });
-        });
-      });
+    runTestSuite(version, validateOverlay);
   });
 
   describe("Fail", () => {
-    readdirSync(`./tests/v1.0/fail`, { withFileTypes: true })
-      .filter((entry) => entry.isFile() && /\.yaml$/.test(entry.name))
-      .forEach((entry) => {
-        test(entry.name, () => {
-          const instance = parseYamlFromFile(`./tests/v1.0/fail/${entry.name}`);
-          const output = validateOverlay(instance, BASIC);
-          expect(output.valid).to.equal(false);
-        });
-      });
+    runTestSuite(version, validateOverlay, "fail");
   });
 });

tests/v1.0/pass/actions-description.yaml

@@ -5,3 +5,4 @@ info:
 actions:
   - target: '$' # Root of document
     description: this is an action description
+    update: {}

tests/v1.0/pass/actions-extensions.yaml

@@ -5,3 +5,4 @@ info:
 actions:
   - target: '$' # Root of document
     x-myActionsExtension: {}
+    update: {}

tests/v1.0/pass/info-extensions.yaml

@@ -5,3 +5,4 @@ info:
   x-myInfoExtension: {}
 actions:
   - target: '$' # Root of document
+    update: {}

tests/v1.0/pass/minimal.yaml

@@ -4,3 +4,4 @@ info:
   version: 1.0.0
 actions:
   - target: '$' # Root of document
+    update: {}

tests/v1.0/pass/root-extensions.yaml

@@ -4,4 +4,5 @@ info:
   version: 1.0.0
 actions:
   - target: '$' # Root of document
+    update: {}
 x-myExtension: {}

tests/v1.1/fail/actions-invalid-description.yaml

@@ -0,0 +1,7 @@
+overlay: 1.1.0
+info:
+  title: Actions invalid description
+  version: 1.0.0
+actions:
+  - target: '$' # Root of document
+    description: 10

tests/v1.1/fail/actions-invalid-target.yaml

@@ -0,0 +1,7 @@
+overlay: 1.1.0
+info:
+  title: Invalid `target`, must begin with `$`
+  version: 1.0.0
+actions:
+  - target: info.description
+    update: An updated description

tests/v1.1/fail/actions-minimal.yaml

@@ -0,0 +1,5 @@
+overlay: 1.1.0
+info:
+  title: Minimal actions
+  version: 1.0.0
+actions: []

tests/v1.1/fail/actions-missing-target.yaml

@@ -0,0 +1,6 @@
+overlay: 1.1.0
+info:
+  title: Missing actions `target`
+  version: 1.0.0
+actions:
+  - update: my description

tests/v1.1/fail/actions-missing.yaml

@@ -0,0 +1,5 @@
+overlay: 1.1.0
+info:
+  title: Missing `actions`
+  version: 1.0.0
+extends: '/openapi.yaml'

tests/v1.1/fail/actions-not-unique.yaml

@@ -0,0 +1,9 @@
+overlay: 1.1.0
+info:
+  title: Actions not unique
+  version: 1.0.0
+actions:
+  - target: '$.info.title'
+    update: 'My New title'
+  - target: '$.info.title'
+    update: 'My New title'

tests/v1.1/fail/extends-invalid-type.yaml

@@ -0,0 +1,7 @@
+overlay: 1.1.0
+info:
+  title: Invalid `extends` type
+  version: 1.0.0
+extends: {}
+actions:
+  - target: '$' # Root of document

tests/v1.1/fail/info-missing-title.yaml

@@ -0,0 +1,5 @@
+overlay: 1.1.0
+info:
+  version: 1.0.0
+actions:
+  - target: '$' # Root of document

tests/v1.1/fail/info-missing-version.yaml

@@ -0,0 +1,5 @@
+overlay: 1.1.0
+info:
+  title: Missing Info version
+actions:
+  - target: '$' # Root of document

tests/v1.1/fail/invalid-overlay-version.yaml

@@ -0,0 +1,6 @@
+overlay: 2
+info:
+  title: Invalid Overlay version
+  version: 1.0.0
+actions:
+  - target: '$' # Root of document

tests/v1.1/fail/not-an-object.yaml

@@ -0,0 +1,5 @@
+- root
+- must
+- be
+- an
+- object

tests/v1.1/fail/not-update-with-remove.yaml

@@ -0,0 +1,10 @@
+overlay: 1.1.0
+info:
+  title: Update many objects at once
+  version: 1.0.0
+actions:
+  - target: $.paths.*.get
+    update:
+      x-safe: true
+    remove: true
+    description: This test could technically be in 1.0 but I'm not sure whether we can edit the schema at this point.

tests/v1.1/pass/actions-array-modification-example-remove.yaml

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

tests/v1.1/pass/actions-array-modification-example-update.yaml

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

tests/v1.1/pass/actions-description.yaml

@@ -0,0 +1,8 @@
+overlay: 1.1.0
+info:
+  title: Actions Description
+  version: 1.0.0
+actions:
+  - target: '$' # Root of document
+    description: this is an action description
+    update: {}

tests/v1.1/pass/actions-extensions.yaml

@@ -0,0 +1,8 @@
+overlay: 1.1.0
+info:
+  title: Actions Extensions
+  version: 1.0.0
+actions:
+  - target: '$' # Root of document
+    x-myActionsExtension: {}
+    update: {}

tests/v1.1/pass/actions-structured-overlay-example.yaml

@@ -0,0 +1,22 @@
+overlay: 1.1.0
+info:
+  title: Structured Overlay
+  version: 1.0.0
+extends: '/openapi.yaml'
+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.1/pass/actions-targeted-overlay-example.yaml

@@ -0,0 +1,16 @@
+overlay: 1.1.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.1/pass/actions-traits-example.yaml

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

tests/v1.1/pass/actions-wildcard-overlay-example.yaml

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

tests/v1.1/pass/info-extensions.yaml

@@ -0,0 +1,8 @@
+overlay: 1.1.0
+info:
+  title: Info Extensions
+  version: 1.0.0
+  x-myInfoExtension: {}
+actions:
+  - target: '$' # Root of document
+    update: {}

tests/v1.1/pass/minimal.yaml

@@ -0,0 +1,7 @@
+overlay: 1.1.0
+info:
+  title: Minimal
+  version: 1.0.0
+actions:
+  - target: '$' # Root of document
+    update: {}

tests/v1.1/pass/root-extensions.yaml

@@ -0,0 +1,8 @@
+overlay: 1.1.0
+info:
+  title: Root Extensions
+  version: 1.0.0
+actions:
+  - target: '$' # Root of document
+    update: {}
+x-myExtension: {}