feat(ns-workflows-1): Add Workflows Spec Object

swagger-api · Dec 4, 2023 · d7f0414 · d7f0414
1 parent fce4096
commit d7f0414
Show file tree

Hide file tree

Showing 5 changed files with 64 additions and 1 deletion.
diff --git a/packages/apidom-ns-workflows-1/README.md b/packages/apidom-ns-workflows-1/README.md
@@ -185,7 +185,7 @@ const workflowsElement = WorkflowsSpecification1Element.refract(apiDOM.result, {
 
 Only fully implemented specification objects should be checked here.
 
-- [ ] [Workflows Specification Object](https://github.com/OAI/sig-workflows/blob/main/versions/1.0.0.md#workflows-specification-object)
+- [x] [Workflows Specification Object](https://github.com/OAI/sig-workflows/blob/main/versions/1.0.0.md#workflows-specification-object)
 - [x] [Info Object](https://github.com/OAI/sig-workflows/blob/main/versions/1.0.0.md#info-object)
 - [x] [Source Description Object](https://github.com/OAI/sig-workflows/blob/main/versions/1.0.0.md#source-description-object)
 - [x] [Workflow Object](https://github.com/OAI/sig-workflows/blob/main/versions/1.0.0.md#workflow-object)

diff --git a/packages/apidom-ns-workflows-1/src/elements/WorkflowsSpecification1.ts b/packages/apidom-ns-workflows-1/src/elements/WorkflowsSpecification1.ts
@@ -2,6 +2,7 @@ import { ObjectElement, ArrayElement, Attributes, Meta } from '@swagger-api/apid
 
 import WorkflowsSpecElement from './WorkflowsSpec';
 import InfoElement from './Info';
+import ComponentsElement from './Components';
 
 class WorkflowsSpecification1 extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
@@ -34,6 +35,22 @@ class WorkflowsSpecification1 extends ObjectElement {
   set sourceDescriptions(sourceDescriptions: ArrayElement | undefined) {
     this.set('sourceDescriptions', sourceDescriptions);
   }
+
+  get workflows(): ArrayElement | undefined {
+    return this.get('workflows');
+  }
+
+  set workflows(workflows: ArrayElement | undefined) {
+    this.set('workflows', workflows);
+  }
+
+  get components(): ComponentsElement | undefined {
+    return this.get('components');
+  }
+
+  set components(components: ComponentsElement | undefined) {
+    this.set('components', components);
+  }
 }
 
 export default WorkflowsSpecification1;
diff --git a/packages/apidom-ns-workflows-1/src/refractor/specification.ts b/packages/apidom-ns-workflows-1/src/refractor/specification.ts
@@ -61,6 +61,8 @@ const specification = {
               $ref: '#/visitors/document/objects/Info',
             },
             sourceDescriptions: SourceDescriptionsVisitor,
+            workflows: WorkflowVisitor,
+            components: ComponentsVisitor,
           },
         },
         Info: {

diff --git a/...s-workflows-1/test/refractor/elements/WorkflowsSpecification1/__snapshots__/index.ts.snap b/...s-workflows-1/test/refractor/elements/WorkflowsSpecification1/__snapshots__/index.ts.snap
@@ -0,0 +1,22 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`refractor elements WorkflowsSpecification1Element should refract to semantic ApiDOM tree 1`] = `
+(WorkflowsSpecification1Element
+  (MemberElement
+    (StringElement)
+    (StringElement))
+  (MemberElement
+    (StringElement)
+    (InfoElement))
+  (MemberElement
+    (StringElement)
+    (ArrayElement
+      (SourceDescriptionElement)))
+  (MemberElement
+    (StringElement)
+    (ArrayElement
+      (ObjectElement)))
+  (MemberElement
+    (StringElement)
+    (ComponentsElement)))
+`;
diff --git a/packages/apidom-ns-workflows-1/test/refractor/elements/WorkflowsSpecification1/index.ts b/packages/apidom-ns-workflows-1/test/refractor/elements/WorkflowsSpecification1/index.ts
@@ -0,0 +1,22 @@
+import { expect } from 'chai';
+import { sexprs } from '@swagger-api/apidom-core';
+
+import { WorkflowsSpecification1Element } from '../../../../src';
+
+describe('refractor', function () {
+  context('elements', function () {
+    context('WorkflowsSpecification1Element', function () {
+      specify('should refract to semantic ApiDOM tree', function () {
+        const workflowsSpecification1Element = WorkflowsSpecification1Element.refract({
+          workflowsSpec: '1.0.0',
+          info: {},
+          sourceDescriptions: [{}],
+          workflows: [{}],
+          components: {},
+        });
+
+        expect(sexprs(workflowsSpecification1Element)).toMatchSnapshot();
+      });
+    });
+  });
+});