refactor(reference): align OpenAPI 2.0 naming strategies with spec (#…

…4625) Refs #4612
swagger-api · Dec 26, 2024 · 7341bf3 · 7341bf3
1 parent 0dcb105
commit 7341bf3
Show file tree

Hide file tree

Showing 126 changed files with 418 additions and 417 deletions.
diff --git a/...ference/test/dereference/strategies/openapi-2/json-reference-object/dereference-apidom.ts b/...ference/test/dereference/strategies/openapi-2/json-reference-object/dereference-apidom.ts
@@ -18,7 +18,7 @@ describe('dereference', function () {
           'given single JSONReferenceElement passed to dereferenceApiDOM with internal references',
           function () {
             context('given dereferencing using local file system', function () {
-              const fixturePath = path.join(__dirname, 'fixtures', 'internal-only', 'root.json');
+              const fixturePath = path.join(__dirname, 'fixtures', 'internal-only', 'entry.json');
 
               specify('should dereference', async function () {
                 const parseResult = await parse(fixturePath, {
@@ -53,13 +53,13 @@ describe('dereference', function () {
 
                 assert.match(
                   toValue(dereferenced.meta.get('ref-origin')),
-                  /internal-only\/root\.json$/,
+                  /internal-only\/entry\.json$/,
                 );
               });
             });
 
             context('given dereferencing using HTTP protocol', function () {
-              const fixturePath = path.join(__dirname, 'fixtures', 'internal-only', 'root.json');
+              const fixturePath = path.join(__dirname, 'fixtures', 'internal-only', 'entry.json');
               const httpPort = 8123;
               let httpServer: ServerTerminable;
 
@@ -83,7 +83,7 @@ describe('dereference', function () {
                 const dereferenced = await dereferenceApiDOM(referenceElement, {
                   parse: { mediaType: mediaTypes.latest('json') },
                   resolve: {
-                    baseURI: `http://localhost:${httpPort}/root.json#/definitions/schema1`,
+                    baseURI: `http://localhost:${httpPort}/entry.json#/definitions/schema1`,
                   },
                 });
 
@@ -101,11 +101,11 @@ describe('dereference', function () {
                 const dereferenced = await dereferenceApiDOM(referenceElement, {
                   parse: { mediaType: mediaTypes.latest('json') },
                   resolve: {
-                    baseURI: `http://localhost:${httpPort}/root.json#/definitions/schema1`,
+                    baseURI: `http://localhost:${httpPort}/entry.json#/definitions/schema1`,
                   },
                 });
 
-                assert.match(toValue(dereferenced.meta.get('ref-origin')), /\/root\.json$/);
+                assert.match(toValue(dereferenced.meta.get('ref-origin')), /\/entry\.json$/);
               });
             });
           },
@@ -115,7 +115,7 @@ describe('dereference', function () {
           'given single JSONReferenceElement passed to dereferenceApiDOM with external references',
           function () {
             context('given dereferencing using local file system', function () {
-              const fixturePath = path.join(__dirname, 'fixtures', 'external-only', 'root.json');
+              const fixturePath = path.join(__dirname, 'fixtures', 'external-only', 'entry.json');
 
               specify('should dereference', async function () {
                 const parseResult = await parse(fixturePath, {
@@ -154,7 +154,7 @@ describe('dereference', function () {
             });
 
             context('given dereferencing using HTTP protocol', function () {
-              const fixturePath = path.join(__dirname, 'fixtures', 'external-only', 'root.json');
+              const fixturePath = path.join(__dirname, 'fixtures', 'external-only', 'entry.json');
               const httpPort = 8123;
               let httpServer: ServerTerminable;
 
@@ -177,7 +177,7 @@ describe('dereference', function () {
                 );
                 const dereferenced = await dereferenceApiDOM(referenceElement, {
                   parse: { mediaType: mediaTypes.latest('json') },
-                  resolve: { baseURI: `http://localhost:${httpPort}/root.json` },
+                  resolve: { baseURI: `http://localhost:${httpPort}/entry.json` },
                 });
 
                 assert.isTrue(isSchemaElement(dereferenced));
@@ -193,7 +193,7 @@ describe('dereference', function () {
                 );
                 const dereferenced = await dereferenceApiDOM(referenceElement, {
                   parse: { mediaType: mediaTypes.latest('json') },
-                  resolve: { baseURI: `http://localhost:${httpPort}/root.json` },
+                  resolve: { baseURI: `http://localhost:${httpPort}/entry.json` },
                 });
 
                 assert.match(toValue(dereferenced.meta.get('ref-origin')), /\/ex\.json$/);
@@ -205,7 +205,7 @@ describe('dereference', function () {
                 __dirname,
                 'fixtures',
                 'external-only-absolute-url',
-                'root.json',
+                'entry.json',
               );
               const httpPort = 8123;
               let httpServer: ServerTerminable;
@@ -229,7 +229,7 @@ describe('dereference', function () {
                 );
                 const dereferenced = await dereferenceApiDOM(referenceElement, {
                   parse: { mediaType: mediaTypes.latest('json') },
-                  resolve: { baseURI: `http://localhost:${httpPort}/root.json` },
+                  resolve: { baseURI: `http://localhost:${httpPort}/entry.json` },
                 });
 
                 assert.isTrue(isSchemaElement(dereferenced));
@@ -245,7 +245,7 @@ describe('dereference', function () {
                 );
                 const dereferenced = await dereferenceApiDOM(referenceElement, {
                   parse: { mediaType: mediaTypes.latest('json') },
-                  resolve: { baseURI: `http://localhost:${httpPort}/root.json` },
+                  resolve: { baseURI: `http://localhost:${httpPort}/entry.json` },
                 });
 
                 assert.match(toValue(dereferenced.meta.get('ref-origin')), /\/ex\.json$/);

diff --git a/...tures/additional-ignored-fields/root.json → ...ures/additional-ignored-fields/entry.json b/...tures/additional-ignored-fields/root.json → ...ures/additional-ignored-fields/entry.json
diff --git a/...-object/fixtures/cycle-internal/root.json → ...object/fixtures/cycle-internal/entry.json b/...-object/fixtures/cycle-internal/root.json → ...object/fixtures/cycle-internal/entry.json
diff --git a/...xtures/direct-external-circular/root.json → ...tures/direct-external-circular/entry.json b/...xtures/direct-external-circular/root.json → ...tures/direct-external-circular/entry.json
diff --git a/...ence/strategies/openapi-2/json-reference-object/fixtures/direct-external-circular/ex.json b/...ence/strategies/openapi-2/json-reference-object/fixtures/direct-external-circular/ex.json
@@ -1,7 +1,7 @@
 {
   "definitions": {
     "externalSchema": {
-      "$ref": "./root.json#/definitions/schema"
+      "$ref": "./entry.json#/definitions/schema"
     }
   }
 

diff --git a/...xtures/direct-internal-circular/root.json → ...tures/direct-internal-circular/entry.json b/...xtures/direct-internal-circular/root.json → ...tures/direct-internal-circular/entry.json
diff --git a/...t/fixtures/direct-self-circular/root.json → .../fixtures/direct-self-circular/entry.json b/...t/fixtures/direct-self-circular/root.json → .../fixtures/direct-self-circular/entry.json
diff --git a/...es/external-circular-dependency/root.json → ...s/external-circular-dependency/entry.json b/...es/external-circular-dependency/root.json → ...s/external-circular-dependency/entry.json
diff --git a/.../strategies/openapi-2/json-reference-object/fixtures/external-circular-dependency/ex.json b/.../strategies/openapi-2/json-reference-object/fixtures/external-circular-dependency/ex.json
@@ -1,10 +1,10 @@
 {
   "definitions": {
     "externalSchema1": {
-      "$ref": "./root.json#/definitions/schema2"
+      "$ref": "./entry.json#/definitions/schema2"
     },
     "externalSchema2": {
-      "$ref": "./root.json#/definitions/schema2"
+      "$ref": "./entry.json#/definitions/schema2"
     },
     "externalSchema3": {
       "type": "string",

diff --git a/...-object/fixtures/external-cycle/root.json → ...object/fixtures/external-cycle/entry.json b/...-object/fixtures/external-cycle/root.json → ...object/fixtures/external-cycle/entry.json
diff --git a/.../fixtures/external-indirections/root.json → ...fixtures/external-indirections/entry.json b/.../fixtures/external-indirections/root.json → ...fixtures/external-indirections/entry.json
diff --git a/...ures/external-only-absolute-url/root.json → ...res/external-only-absolute-url/entry.json b/...ures/external-only-absolute-url/root.json → ...res/external-only-absolute-url/entry.json
diff --git a/...e-object/fixtures/external-only/root.json → ...-object/fixtures/external-only/entry.json b/...e-object/fixtures/external-only/root.json → ...-object/fixtures/external-only/entry.json
diff --git a/...fixtures/ignore-arbitrary-$refs/root.json → ...ixtures/ignore-arbitrary-$refs/entry.json b/...fixtures/ignore-arbitrary-$refs/root.json → ...ixtures/ignore-arbitrary-$refs/entry.json
diff --git a/...object/fixtures/ignore-external/root.json → ...bject/fixtures/ignore-external/entry.json b/...object/fixtures/ignore-external/root.json → ...bject/fixtures/ignore-external/entry.json
diff --git a/...ures/indirect-external-circular/root.json → ...res/indirect-external-circular/entry.json b/...ures/indirect-external-circular/root.json → ...res/indirect-external-circular/entry.json
diff --git a/...e/strategies/openapi-2/json-reference-object/fixtures/indirect-external-circular/ex3.json b/...e/strategies/openapi-2/json-reference-object/fixtures/indirect-external-circular/ex3.json
@@ -1,7 +1,7 @@
 {
   "definitions": {
     "indirection": {
-      "$ref": "./root.json#/definitions/schema"
+      "$ref": "./entry.json#/definitions/schema"
     }
   }
 }
diff --git a/...ures/indirect-internal-circular/root.json → ...res/indirect-internal-circular/entry.json b/...ures/indirect-internal-circular/root.json → ...res/indirect-internal-circular/entry.json
diff --git a/...ject/fixtures/internal-external/root.json → ...ect/fixtures/internal-external/entry.json b/...ject/fixtures/internal-external/root.json → ...ect/fixtures/internal-external/entry.json
diff --git a/...e-object/fixtures/internal-only/root.json → ...-object/fixtures/internal-only/entry.json b/...e-object/fixtures/internal-only/root.json → ...-object/fixtures/internal-only/entry.json
diff --git a/...object/fixtures/invalid-pointer/root.json → ...bject/fixtures/invalid-pointer/entry.json b/...object/fixtures/invalid-pointer/root.json → ...bject/fixtures/invalid-pointer/entry.json
diff --git a/...rence-object/fixtures/max-depth/root.json → ...ence-object/fixtures/max-depth/entry.json b/...rence-object/fixtures/max-depth/root.json → ...ence-object/fixtures/max-depth/entry.json
diff --git a/.../path-encoding/path with spaces/root.json → ...path-encoding/path with spaces/entry.json b/.../path-encoding/path with spaces/root.json → ...path-encoding/path with spaces/entry.json
diff --git a/...bject/fixtures/refset-as-option/root.json → ...ject/fixtures/refset-as-option/entry.json b/...bject/fixtures/refset-as-option/root.json → ...ject/fixtures/refset-as-option/entry.json
diff --git a/...fixtures/unresolvable-reference/root.json → ...ixtures/unresolvable-reference/entry.json b/...fixtures/unresolvable-reference/root.json → ...ixtures/unresolvable-reference/entry.json