feat(OpenApi3.1): add support for additional fields to Operation

Refs #66

apidom/packages/@types/minim.d.ts

@@ -58,7 +58,9 @@ declare module 'minim' {
 
   export class NullElement extends Element {}
 
-  export class BooleanElement extends Element {}
+  export class BooleanElement extends Element {
+    constructor(content?: boolean, meta?: Meta, attributes?: Attributes);
+  }
 
   export class ArrayElement extends Element {
     first: Element | undefined;
@@ -80,6 +82,8 @@ declare module 'minim' {
     get(key: string): any;
 
     set(key: string | StringElement, value: any): void;
+
+    hasKey(value: string): boolean;
   }
 
   export class MemberElement extends Element {

apidom/packages/apidom-ns-openapi3-1/src/elements/Operation.ts

@@ -1,4 +1,4 @@
-import { Attributes, Meta, ObjectElement, StringElement } from 'minim';
+import { Attributes, BooleanElement, Meta, ObjectElement, StringElement } from 'minim';
 import ParameterElement from './Parameter';
 import ReferenceElement from './Reference';
 
@@ -40,6 +40,17 @@ class Operation extends ObjectElement {
     this.set('operationId', operationId);
   }
 
+  get deprecated(): BooleanElement {
+    if (this.hasKey('deprecated')) {
+      return this.get('deprecated');
+    }
+    return new BooleanElement(false);
+  }
+
+  set deprecated(deprecated: BooleanElement) {
+    this.set('deprecated', deprecated);
+  }
+
   get parameters(): ParameterElement | ReferenceElement {
     return this.get('parameters');
   }

apidom/packages/apidom-parser-adapter-openapi3-1-json/src/parser/specification.ts

@@ -33,15 +33,13 @@ import PathItemVisitor from './visitors/open-api-3-1/path-item';
 import PathItem$RefVisitor from './visitors/open-api-3-1/path-item/$RefVisitor';
 import PathItemSummaryVisitor from './visitors/open-api-3-1/path-item/SummaryVisitor';
 import PathItemDescriptionVisitor from './visitors/open-api-3-1/path-item/DescriptionVisitor';
-import PathItemGetVisitor from './visitors/open-api-3-1/path-item/GetVisitor';
-import PathItemPutVisitor from './visitors/open-api-3-1/path-item/PutVisitor';
-import PathItemPostVisitor from './visitors/open-api-3-1/path-item/PostVisitor';
-import PathItemDeleteVisitor from './visitors/open-api-3-1/path-item/DeleteVisitor';
-import PathItemOptionsVisitor from './visitors/open-api-3-1/path-item/OptionsVisitor';
-import PathItemHeadVisitor from './visitors/open-api-3-1/path-item/HeadVisitor';
-import PathItemPatchVisitor from './visitors/open-api-3-1/path-item/PatchVisitor';
-import PathItemTraceVisitor from './visitors/open-api-3-1/path-item/TraceVisitor';
 import ParametersVisitor from './visitors/open-api-3-1/ParametersVisitor';
+import OperationVisitor from './visitors/open-api-3-1/operation';
+import OperationSummaryVisitor from './visitors/open-api-3-1/operation/SummaryVisitor';
+import OperationDescriptionVisitor from './visitors/open-api-3-1/operation/DescriptionVisitor';
+import OperationOperationIdVisitor from './visitors/open-api-3-1/operation/OperationIdVisitor';
+import OperationTagsVisitor from './visitors/open-api-3-1/operation/TagsVisitor';
+import OperationDeprecatedVisitor from './visitors/open-api-3-1/operation/DeprecatedVisitor';
 
 import ErrorVisitor from './visitors/ErrorVisitor';
 import { ValueVisitor, ObjectVisitor, ArrayVisitor } from './visitors/generics';
@@ -145,18 +143,44 @@ const specification = {
             $ref: PathItem$RefVisitor,
             summary: PathItemSummaryVisitor,
             description: PathItemDescriptionVisitor,
-            get: PathItemGetVisitor,
-            put: PathItemPutVisitor,
-            post: PathItemPostVisitor,
-            delete: PathItemDeleteVisitor,
-            options: PathItemOptionsVisitor,
-            head: PathItemHeadVisitor,
-            patch: PathItemPatchVisitor,
-            trace: PathItemTraceVisitor,
+            get: {
+              $ref: '#/visitors/document/objects/Operation',
+            },
+            put: {
+              $ref: '#/visitors/document/objects/Operation',
+            },
+            post: {
+              $ref: '#/visitors/document/objects/Operation',
+            },
+            delete: {
+              $ref: '#/visitors/document/objects/Operation',
+            },
+            options: {
+              $ref: '#/visitors/document/objects/Operation',
+            },
+            head: {
+              $ref: '#/visitors/document/objects/Operation',
+            },
+            patch: {
+              $ref: '#/visitors/document/objects/Operation',
+            },
+            trace: {
+              $ref: '#/visitors/document/objects/Operation',
+            },
             servers: ServersVisitor,
             parameters: ParametersVisitor,
           },
         },
+        Operation: {
+          $visitor: OperationVisitor,
+          fields: {
+            tags: OperationTagsVisitor,
+            summary: OperationSummaryVisitor,
+            description: OperationDescriptionVisitor,
+            operationId: OperationOperationIdVisitor,
+            deprecated: OperationDeprecatedVisitor,
+          },
+        },
       },
       extension: SpecificationExtensionVisitor,
     },

apidom/packages/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/generics/JsonBooleanVisitor.ts

@@ -0,0 +1,22 @@
+import stampit from 'stampit';
+import { BREAK } from '..';
+import SpecificationVisitor from '../SpecificationVisitor';
+
+const JsonBooleanVisitor = stampit(SpecificationVisitor, {
+  methods: {
+    true(trueNode) {
+      const booleanElement = new this.namespace.elements.Boolean(true);
+      this.element = this.maybeAddSourceMap(trueNode, booleanElement);
+
+      return BREAK;
+    },
+    false(falseNode) {
+      const booleanElement = new this.namespace.elements.Boolean(false);
+      this.element = this.maybeAddSourceMap(falseNode, booleanElement);
+
+      return BREAK;
+    },
+  },
+});
+
+export default JsonBooleanVisitor;

apidom/packages/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/operation/DeprecatedVisitor.ts

@@ -0,0 +1,6 @@
+import stampit from 'stampit';
+import JsonBooleanVisitor from '../../generics/JsonBooleanVisitor';
+
+const DeprecatedVisitor = stampit(JsonBooleanVisitor);
+
+export default DeprecatedVisitor;

apidom/packages/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/operation/DescriptionVisitor.ts

@@ -0,0 +1,6 @@
+import stampit from 'stampit';
+import JsonStringVisitor from '../../generics/JsonStringVisitor';
+
+const DescriptionVisitor = stampit(JsonStringVisitor);
+
+export default DescriptionVisitor;

apidom/packages/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/operation/OperationIdVisitor.ts

@@ -0,0 +1,6 @@
+import stampit from 'stampit';
+import JsonStringVisitor from '../../generics/JsonStringVisitor';
+
+const OperationIdVisitor = stampit(JsonStringVisitor);
+
+export default OperationIdVisitor;

apidom/packages/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/operation/SummaryVisitor.ts

@@ -0,0 +1,6 @@
+import stampit from 'stampit';
+import JsonStringVisitor from '../../generics/JsonStringVisitor';
+
+const SummaryVisitor = stampit(JsonStringVisitor);
+
+export default SummaryVisitor;

apidom/packages/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/operation/TagsVisitor.ts

@@ -0,0 +1,24 @@
+import stampit from 'stampit';
+import { JsonString, isJsonString } from 'apidom-ast';
+
+import { BREAK } from '../..';
+import SpecificationVisitor from '../../SpecificationVisitor';
+
+const TagsVisitor = stampit(SpecificationVisitor, {
+  methods: {
+    array(arrayNode) {
+      const tagElements = arrayNode.items
+        .filter(isJsonString)
+        .map((stringNode: JsonString) => this.nodeToElement(['value'], stringNode));
+
+      const tagsElement = new this.namespace.elements.Array(tagElements);
+      tagsElement.classes.push('tags');
+
+      this.element = this.maybeAddSourceMap(arrayNode, tagsElement);
+
+      return BREAK;
+    },
+  },
+});
+
+export default TagsVisitor;

apidom/packages/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/operation/index.ts

@@ -0,0 +1,14 @@
+import stampit from 'stampit';
+
+import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
+
+const OperationVisitor = stampit(FixedFieldsJsonObjectVisitor, {
+  props: {
+    specPath: ['document', 'objects', 'Operation'],
+  },
+  init() {
+    this.element = new this.namespace.elements.Operation();
+  },
+});
+
+export default OperationVisitor;

apidom/packages/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/path-item/index.ts

@@ -1,4 +1,6 @@
 import stampit from 'stampit';
+import { StringElement } from 'minim';
+import { isOperationElement, OperationElement } from 'apidom-ns-openapi3-1';
 
 import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
 
@@ -9,6 +11,23 @@ const PathItemVisitor = stampit(FixedFieldsJsonObjectVisitor, {
   init() {
     this.element = new this.namespace.elements.PathItem();
   },
+  methods: {
+    object(objectNode) {
+      // @ts-ignore
+      const result = FixedFieldsJsonObjectVisitor.compose.methods.object.call(this, objectNode);
+
+      // decorate Operation elements with HTTP method
+      this.element
+        .filter(isOperationElement)
+        .forEach((operationElement: OperationElement, httpMethodElementCI: StringElement) => {
+          const httpMethod = httpMethodElementCI.toValue().toUpperCase();
+          const httpMethodElementCS = new this.namespace.elements.String(httpMethod);
+          operationElement.setMetaProperty('httpMethod', httpMethodElementCS);
+        });
+
+      return result;
+    },
+  },
 });
 
 export default PathItemVisitor;

apidom/packages/apidom-parser-adapter-openapi3-1-json/test/fixtures/sample-api.json

@@ -82,8 +82,11 @@
       "summary": "path item summary",
       "description": "path item description",
       "get": {
+        "tags": ["tag1", "tag2"],
         "summary": "Returns a list of users.",
         "description": "Optional extended description in CommonMark or HTML.",
+        "operationId": "getUserList",
+        "deprecated": true,
         "responses": {
           "200": {
             "description": "A JSON array of user names",