feat(ns-openapi-3-1): add reference metadata

Refs swagger-api/oss-planning#265
swagger-api · Aug 2, 2021 · 5ab586e · 5ab586e
1 parent e66cdaa
commit 5ab586e
Show file tree

Hide file tree

Showing 7 changed files with 198 additions and 12 deletions.
diff --git a/apidom/packages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/example/index.ts b/apidom/packages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/example/index.ts
@@ -1,5 +1,6 @@
 import stampit from 'stampit';
 import { always } from 'ramda';
+import { ObjectElement, isStringElement } from 'apidom';
 
 import ExampleElement from '../../../../elements/Example';
 import FallbackVisitor from '../../FallbackVisitor';
@@ -13,6 +14,19 @@ const ExampleVisitor = stampit(FixedFieldsVisitor, FallbackVisitor, {
   init() {
     this.element = new ExampleElement();
   },
+  methods: {
+    ObjectElement(objectElement: ObjectElement) {
+      // @ts-ignore
+      const result = FixedFieldsVisitor.compose.methods.ObjectElement.call(this, objectElement);
+
+      // mark this ExampleElement with reference metadata
+      if (isStringElement(this.element.externalValue)) {
+        this.element.classes.push('reference-element');
+      }
+
+      return result;
+    },
+  },
 });
 
 export default ExampleVisitor;
diff --git a/...ages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/link/OperationIdVisitor.ts b/...ages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/link/OperationIdVisitor.ts
@@ -1,5 +1,17 @@
+import stampit from 'stampit';
+import { StringElement, BREAK } from 'apidom';
+
 import FallbackVisitor from '../../FallbackVisitor';
 
-const OperationIdVisitor = FallbackVisitor;
+const OperationIdVisitor = stampit(FallbackVisitor, {
+  methods: {
+    StringElement(stringElement: StringElement) {
+      this.element = stringElement.clone();
+      this.element.classes.push('reference-value');
+
+      return BREAK;
+    },
+  },
+});
 
 export default OperationIdVisitor;
diff --git a/apidom/packages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/link/index.ts b/apidom/packages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/link/index.ts
@@ -1,5 +1,6 @@
 import stampit from 'stampit';
 import { always } from 'ramda';
+import { isStringElement, ObjectElement } from 'apidom';
 
 import LinkElement from '../../../../elements/Link';
 import FallbackVisitor from '../../FallbackVisitor';
@@ -13,6 +14,19 @@ const LinkVisitor = stampit(FixedFieldsVisitor, FallbackVisitor, {
   init() {
     this.element = new LinkElement();
   },
+  methods: {
+    ObjectElement(objectElement: ObjectElement) {
+      // @ts-ignore
+      const result = FixedFieldsVisitor.compose.methods.ObjectElement.call(this, objectElement);
+
+      // mark this LinkElement with reference metadata
+      if (isStringElement(this.element.operationId) || isStringElement(this.element.operationRef)) {
+        this.element.classes.push('reference-element');
+      }
+
+      return result;
+    },
+  },
 });
 
 export default LinkVisitor;
diff --git a/apidom/packages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/path-item/index.ts b/apidom/packages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/path-item/index.ts
@@ -1,6 +1,6 @@
 import stampit from 'stampit';
 import { always } from 'ramda';
-import { StringElement, ObjectElement } from 'apidom';
+import { StringElement, ObjectElement, isStringElement } from 'apidom';
 
 import PathItemElement from '../../../../elements/PathItem';
 import OperationElement from '../../../../elements/Operation';
@@ -29,6 +29,11 @@ const PathItemVisitor = stampit(FixedFieldsVisitor, FallbackVisitor, {
           operationElement.setMetaProperty('httpMethod', httpMethodElementCS);
         });
 
+      // mark this PathItemElement with reference metadata
+      if (isStringElement(this.element.$ref)) {
+        this.element.classes.push('reference-element');
+      }
+
       return result;
     },
   },

diff --git a/apidom/packages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/reference/index.ts b/apidom/packages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/reference/index.ts
@@ -1,5 +1,6 @@
 import stampit from 'stampit';
 import { always } from 'ramda';
+import { ObjectElement, isStringElement } from 'apidom';
 
 import ReferenceElement from '../../../../elements/Reference';
 import FixedFieldsVisitor from '../../generics/FixedFieldsVisitor';
@@ -13,6 +14,19 @@ const ReferenceVisitor = stampit(FixedFieldsVisitor, FallbackVisitor, {
   init() {
     this.element = new ReferenceElement();
   },
+  methods: {
+    ObjectElement(objectElement: ObjectElement) {
+      // @ts-ignore
+      const result = FixedFieldsVisitor.compose.methods.ObjectElement.call(this, objectElement);
+
+      // mark this ReferenceElement with reference metadata
+      if (isStringElement(this.element.$ref)) {
+        this.element.classes.push('reference-element');
+      }
+
+      return result;
+    },
+  },
 });
 
 export default ReferenceVisitor;
diff --git a/apidom/packages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/schema/index.ts b/apidom/packages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/schema/index.ts
@@ -79,27 +79,25 @@ const SchemaVisitor = stampit(FixedFieldsVisitor, ParentSchemaAwareVisitor, Fall
       this.element.setMetaProperty('inherited$id', inherited$id);
     };
 
-    const appendReferenceMetadata = (objectElement: ObjectElement) => {
-      const $ref = objectElement.get('$ref')?.toValue();
-
-      if (isNonEmptyString($ref)) {
-        this.element.classes.push('reference-element');
-      }
-    };
-
     /**
      * Public Api.
      */
     this.ObjectElement = function _ObjectElement(objectElement: ObjectElement) {
       this.element = new SchemaElement();
       handle$schema(objectElement);
       handle$id(objectElement);
-      appendReferenceMetadata(objectElement);
 
       // for further processing consider this Schema Element as parent for all embedded Schema Elements
       this.parent = this.element;
       // @ts-ignore
-      return FixedFieldsVisitor.compose.methods.ObjectElement.call(this, objectElement);
+      const result = FixedFieldsVisitor.compose.methods.ObjectElement.call(this, objectElement);
+
+      // mark this SchemaElement with reference metadata
+      if (isStringElement(this.element.$ref)) {
+        this.element.classes.push('reference-element');
+      }
+
+      return result;
     };
 
     this.BooleanElement = function _BooleanElement(booleanElement: BooleanElement) {