feat(reference): add support for OpenAPI 3.0.4 (#4624)

Refs #4612
swagger-api · Dec 26, 2024 · 0dcb105 · 0dcb105
1 parent 1d0b4a5
commit 0dcb105
Show file tree

Hide file tree

Showing 214 changed files with 688 additions and 677 deletions.
diff --git a/packages/apidom-reference/.mocharc.json b/packages/apidom-reference/.mocharc.json
@@ -1,5 +1,6 @@
 {
   "recursive": true,
   "spec": "test/**/*.mjs",
-  "file": ["test/mocha-bootstrap.mjs"]
+  "file": ["test/mocha-bootstrap.mjs"],
+  "ignore": ["test/perf/**/*.mjs"]
 }
diff --git a/packages/apidom-reference/README.md b/packages/apidom-reference/README.md
@@ -132,7 +132,7 @@ Supported media types are:
 #### [openapi-json-3-0](https://github.com/swagger-api/apidom/tree/main/packages/apidom-reference/src/parse/parsers/openapi-json-3-0)
 
 Wraps [@swagger-api/apidom-parser-adapter-openapi-json-3-0](https://github.com/swagger-api/apidom/tree/main/packages/apidom-parser-adapter-openapi-json-3-0) package
-and is uniquely  identified by `openapi-json-3-1` name.
+and is uniquely  identified by `openapi-json-3-0` name.
 
 Supported media types are:
 
@@ -146,6 +146,8 @@ Supported media types are:
   'application/vnd.oai.openapi+json;version=3.0.2',
   'application/vnd.oai.openapi;version=3.0.3',
   'application/vnd.oai.openapi+json;version=3.0.3',
+  'application/vnd.oai.openapi;version=3.0.4',
+  'application/vnd.oai.openapi+json;version=3.0.4',
 ]
 ```
 
@@ -166,7 +168,7 @@ Supported media types are:
 #### [openapi-yaml-3-0](https://github.com/swagger-api/apidom/tree/main/packages/apidom-reference/src/parse/parsers/openapi-yaml-3-0)
 
 Wraps [@swagger-api/apidom-parser-adapter-openapi-yaml-3-0](https://github.com/swagger-api/apidom/tree/main/packages/apidom-parser-adapter-openapi-yaml-3-0) package
-and is uniquely  identified by `openapi-yaml-3-1` name.
+and is uniquely  identified by `openapi-yaml-3-0` name.
 
 Supported media types are:
 
@@ -180,6 +182,8 @@ Supported media types are:
   'application/vnd.oai.openapi+yaml;version=3.0.2',
   'application/vnd.oai.openapi;version=3.0.3',
   'application/vnd.oai.openapi+yaml;version=3.0.3',
+  'application/vnd.oai.openapi;version=3.0.4',
+  'application/vnd.oai.openapi+yaml;version=3.0.4',
 ]
 ```
 
@@ -1187,7 +1191,7 @@ Supported media types:
 
 ##### [openapi-3-0](https://github.com/swagger-api/apidom/tree/main/packages/apidom-reference/src/resolve/strategies/openapi-3-0)
 
-External resolution strategy for understanding and resolving external dependencies of [OpenApi 3.0.x](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md) definitions.
+External resolution strategy for understanding and resolving external dependencies of [OpenApi 3.0.x](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.4.md) definitions.
 
 Supported media types:
 
@@ -1205,6 +1209,9 @@ Supported media types:
   'application/vnd.oai.openapi;version=3.0.3',
   'application/vnd.oai.openapi+json;version=3.0.3',
   'application/vnd.oai.openapi+yaml;version=3.0.3',
+  'application/vnd.oai.openapi;version=3.0.4',
+  'application/vnd.oai.openapi+json;version=3.0.4',
+  'application/vnd.oai.openapi+yaml;version=3.0.4',
 ]
 ```
 
@@ -1555,7 +1562,7 @@ Supported media types:
 
 ##### [openapi-3-0](https://github.com/swagger-api/apidom/tree/main/packages/apidom-reference/src/dereference/strategies/openapi-3-0)
 
-Dereference strategy for dereferencing [OpenApi 3.0.x](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md) definitions.
+Dereference strategy for dereferencing [OpenApi 3.0.x](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.4.md) definitions.
 
 Supported media types:
 
@@ -1573,6 +1580,9 @@ Supported media types:
   'application/vnd.oai.openapi;version=3.0.3',
   'application/vnd.oai.openapi+json;version=3.0.3',
   'application/vnd.oai.openapi+yaml;version=3.0.3',
+  'application/vnd.oai.openapi;version=3.0.4',
+  'application/vnd.oai.openapi+json;version=3.0.4',
+  'application/vnd.oai.openapi+yaml;version=3.0.4',
 ]
 ```
 

diff --git a/...dereference/strategies/openapi-2/path-item-object/fixtures/direct-self-circular/root.json b/...dereference/strategies/openapi-2/path-item-object/fixtures/direct-self-circular/root.json
@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "2.0",
   "paths": {
     "/path1": {
       "$ref": "#/paths/~1path1"

diff --git a/...ce/strategies/openapi-3-0/callback-object/fixtures/components-callbacks/dereferenced.json b/...ce/strategies/openapi-3-0/callback-object/fixtures/components-callbacks/dereferenced.json
@@ -1,6 +1,6 @@
 [
   {
-    "openapi": "3.0.3",
+    "openapi": "3.0.4",
     "components": {
       "callbacks": {
         "callback1": {

diff --git a/...t/fixtures/components-callbacks/root.json → .../fixtures/components-callbacks/entry.json b/...t/fixtures/components-callbacks/root.json → .../fixtures/components-callbacks/entry.json
@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.0.4",
   "components": {
     "callbacks": {
       "callback1": {

diff --git a/...erence/strategies/openapi-3-0/callback-object/fixtures/operation-object/dereferenced.json b/...erence/strategies/openapi-3-0/callback-object/fixtures/operation-object/dereferenced.json
@@ -1,6 +1,6 @@
 [
   {
-    "openapi": "3.0.3",
+    "openapi": "3.0.4",
     "paths": {
       "/path": {
         "get": {

diff --git a/...bject/fixtures/operation-object/root.json → ...ject/fixtures/operation-object/entry.json b/...bject/fixtures/operation-object/root.json → ...ject/fixtures/operation-object/entry.json
@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.0.4",
   "paths": {
     "/path": {
       "get": {

diff --git a/packages/apidom-reference/test/dereference/strategies/openapi-3-0/callback-object/index.ts b/packages/apidom-reference/test/dereference/strategies/openapi-3-0/callback-object/index.ts
@@ -8,18 +8,18 @@ import { loadJsonFile } from '../../../../helpers.ts';
 import { dereference } from '../../../../../src/index.ts';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const rootFixturePath = path.join(__dirname, 'fixtures');
+const entryFixturePath = path.join(__dirname, 'fixtures');
 
 describe('dereference', function () {
   context('strategies', function () {
     context('openapi-3-0', function () {
       context('Callback Object', function () {
         context('given in components/callbacks field', function () {
-          const fixturePath = path.join(rootFixturePath, 'components-callbacks');
+          const fixturePath = path.join(entryFixturePath, 'components-callbacks');
 
           specify('should dereference', async function () {
-            const rootFilePath = path.join(fixturePath, 'root.json');
-            const actual = await dereference(rootFilePath, {
+            const entryFilePath = path.join(fixturePath, 'entry.json');
+            const actual = await dereference(entryFilePath, {
               parse: { mediaType: mediaTypes.latest('json') },
             });
             const expected = loadJsonFile(path.join(fixturePath, 'dereferenced.json'));
@@ -29,11 +29,11 @@ describe('dereference', function () {
         });
 
         context('given in Operation Object', function () {
-          const fixturePath = path.join(rootFixturePath, 'operation-object');
+          const fixturePath = path.join(entryFixturePath, 'operation-object');
 
           specify('should dereference', async function () {
-            const rootFilePath = path.join(fixturePath, 'root.json');
-            const actual = await dereference(rootFilePath, {
+            const entryFilePath = path.join(fixturePath, 'entry.json');
+            const actual = await dereference(entryFilePath, {
               parse: { mediaType: mediaTypes.latest('json') },
             });
             const expected = loadJsonFile(path.join(fixturePath, 'dereferenced.json'));

diff --git a/...om-reference/test/dereference/strategies/openapi-3-0/example-object/dereference-apidom.ts b/...om-reference/test/dereference/strategies/openapi-3-0/example-object/dereference-apidom.ts
@@ -19,7 +19,7 @@ describe('dereference', function () {
     context('openapi-3-0', function () {
       context('Example Object', function () {
         context('given single ExampleElement passed to dereferenceApiDOM', function () {
-          const fixturePath = path.join(__dirname, 'fixtures', 'external-value-json', 'root.json');
+          const fixturePath = path.join(__dirname, 'fixtures', 'external-value-json', 'entry.json');
 
           specify('should dereference', async function () {
             const parseResult = await parse(fixturePath, {

diff --git a/...ence/strategies/openapi-3-0/example-object/fixtures/components-examples/dereferenced.json b/...ence/strategies/openapi-3-0/example-object/fixtures/components-examples/dereferenced.json
@@ -1,6 +1,6 @@
 [
   {
-    "openapi": "3.0.3",
+    "openapi": "3.0.4",
     "components": {
       "examples": {
         "example1": {

diff --git a/...ct/fixtures/components-examples/root.json → ...t/fixtures/components-examples/entry.json b/...ct/fixtures/components-examples/root.json → ...t/fixtures/components-examples/entry.json
@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.0.4",
   "components": {
     "examples": {
       "example1": {

diff --git a/...ce/strategies/openapi-3-0/example-object/fixtures/external-value-binary/dereferenced.json b/...ce/strategies/openapi-3-0/example-object/fixtures/external-value-binary/dereferenced.json
@@ -1,6 +1,6 @@
 [
   {
-    "openapi": "3.0.3",
+    "openapi": "3.0.4",
     "components": {
       "examples": {
         "example1": {

diff --git a/.../fixtures/external-value-binary/root.json → ...fixtures/external-value-binary/entry.json b/.../fixtures/external-value-binary/root.json → ...fixtures/external-value-binary/entry.json
@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.0.4",
   "components": {
     "examples": {
       "example1": {

diff --git a/...gies/openapi-3-0/example-object/fixtures/external-value-ignore-external/dereferenced.json b/...gies/openapi-3-0/example-object/fixtures/external-value-ignore-external/dereferenced.json
@@ -1,6 +1,6 @@
 [
   {
-    "openapi": "3.0.3",
+    "openapi": "3.0.4",
     "components": {
       "examples": {
         "example1": {

diff --git a/...ct/fixtures/external-value-json/root.json → ...external-value-ignore-external/entry.json b/...ct/fixtures/external-value-json/root.json → ...external-value-ignore-external/entry.json
@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.0.4",
   "components": {
     "examples": {
       "example1": {

diff --git a/...ence/strategies/openapi-3-0/example-object/fixtures/external-value-json/dereferenced.json b/...ence/strategies/openapi-3-0/example-object/fixtures/external-value-json/dereferenced.json
@@ -1,6 +1,6 @@
 [
   {
-    "openapi": "3.0.3",
+    "openapi": "3.0.4",
     "components": {
       "examples": {
         "example1": {

diff --git a/.../external-value-ignore-external/root.json → ...t/fixtures/external-value-json/entry.json b/.../external-value-ignore-external/root.json → ...t/fixtures/external-value-json/entry.json
@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.0.4",
   "components": {
     "examples": {
       "example1": {

diff --git a/...e/strategies/openapi-3-0/example-object/fixtures/external-value-pointer/dereferenced.json b/...e/strategies/openapi-3-0/example-object/fixtures/external-value-pointer/dereferenced.json
@@ -1,6 +1,6 @@
 [
   {
-    "openapi": "3.0.3",
+    "openapi": "3.0.4",
     "components": {
       "examples": {
         "example1": {

diff --git a/...fixtures/external-value-pointer/root.json → ...ixtures/external-value-pointer/entry.json b/...fixtures/external-value-pointer/root.json → ...ixtures/external-value-pointer/entry.json
@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.0.4",
   "components": {
     "examples": {
       "example1": {

diff --git a/...ence/strategies/openapi-3-0/example-object/fixtures/external-value-text/dereferenced.json b/...ence/strategies/openapi-3-0/example-object/fixtures/external-value-text/dereferenced.json
@@ -1,6 +1,6 @@
 [
   {
-    "openapi": "3.0.3",
+    "openapi": "3.0.4",
     "components": {
       "examples": {
         "example1": {

diff --git a/...ct/fixtures/external-value-text/root.json → ...t/fixtures/external-value-text/entry.json b/...ct/fixtures/external-value-text/root.json → ...t/fixtures/external-value-text/entry.json
@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.0.4",
   "components": {
     "examples": {
       "example1": {

diff --git a/.../external-value-ignore-external/root.json → ...es/external-value-unresolvable/entry.json b/.../external-value-ignore-external/root.json → ...es/external-value-unresolvable/entry.json
@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.0.4",
   "components": {
     "examples": {
       "example1": {

diff --git a/...ternal-value-value-both-defined/root.json → ...ernal-value-value-both-defined/entry.json b/...ternal-value-value-both-defined/root.json → ...ernal-value-value-both-defined/entry.json
@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.0.4",
   "components": {
     "examples": {
       "example1": {

diff --git a/...ence/strategies/openapi-3-0/example-object/fixtures/external-value-yaml/dereferenced.json b/...ence/strategies/openapi-3-0/example-object/fixtures/external-value-yaml/dereferenced.json
@@ -1,6 +1,6 @@
 [
   {
-    "openapi": "3.0.3",
+    "openapi": "3.0.4",
     "components": {
       "examples": {
         "example1": {

diff --git a/...ct/fixtures/external-value-yaml/root.json → ...t/fixtures/external-value-yaml/entry.json b/...ct/fixtures/external-value-yaml/root.json → ...t/fixtures/external-value-yaml/entry.json
@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.0.4",
   "components": {
     "examples": {
       "example1": {

diff --git a/...erence/strategies/openapi-3-0/example-object/fixtures/media-type-object/dereferenced.json b/...erence/strategies/openapi-3-0/example-object/fixtures/media-type-object/dereferenced.json
@@ -1,6 +1,6 @@
 [
   {
-    "openapi": "3.0.3",
+    "openapi": "3.0.4",
     "paths": {
       "/path": {
         "get": {

diff --git a/...ject/fixtures/media-type-object/root.json → ...ect/fixtures/media-type-object/entry.json b/...ject/fixtures/media-type-object/root.json → ...ect/fixtures/media-type-object/entry.json
@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.0.4",
   "paths": {
     "/path": {
       "get": {

diff --git a/...ference/strategies/openapi-3-0/example-object/fixtures/parameter-object/dereferenced.json b/...ference/strategies/openapi-3-0/example-object/fixtures/parameter-object/dereferenced.json
@@ -1,6 +1,6 @@
 [
   {
-    "openapi": "3.0.3",
+    "openapi": "3.0.4",
     "components": {
       "parameters": {
         "param1": {

diff --git a/...bject/fixtures/parameter-object/root.json → ...ject/fixtures/parameter-object/entry.json b/...bject/fixtures/parameter-object/root.json → ...ject/fixtures/parameter-object/entry.json
@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.0.4",
   "components": {
     "parameters": {
       "param1": {