Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(ns-workflows-1): Add Step Object #3471

Merged
merged 8 commits into from
Dec 1, 2023
Merged

feat(ns-workflows-1): Add Step Object #3471

merged 8 commits into from
Dec 1, 2023
+1,111 −2

Conversation

frankkilcommins
Copy link
Collaborator

Refs: #3392

Add Step Object to apidom-ns-workflows-1

@frankkilcommins frankkilcommins added enhancement New feature or request ApiDOM Workflows Workflows specification labels Nov 29, 2023
@char0n char0n self-assigned this Nov 30, 2023
char0n
char0n requested changes Dec 1, 2023
View reviewed changes
Copy link
Member

@char0n char0n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some changes still needed before we can merge. Thank you for patience ;]

packages/apidom-ns-workflows-1/src/refractor/visitors/workflows-1/ParametersVisitor.ts
@@ -0,0 +1,36 @@
import stampit from 'stampit';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be located in workflows-1/step/ParametersVisitor.ts

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks - nice spot. Location changed

packages/apidom-ns-workflows-1/src/refractor/visitors/workflows-1/StepOnFailureVisitor.ts Outdated
@@ -0,0 +1,28 @@
import stampit from 'stampit';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be located in workflows-1/step/OnFailureVisitor.ts and the name of visitor should be OnFailureVisitor.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks - nice spot. Location changed

packages/apidom-ns-workflows-1/src/refractor/visitors/workflows-1/StepOnSuccessVisitor.ts Outdated
@@ -0,0 +1,28 @@
import stampit from 'stampit';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be located in workflows-1/step/OnSuccessVisitor.ts and the name of visitor should be OnSuccessVisitor.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks - nice spot. Location changed

packages/apidom-ns-workflows-1/src/refractor/visitors/workflows-1/StepSuccessCriteriaVisitor.ts Outdated
@@ -0,0 +1,28 @@
import stampit from 'stampit';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be located in workflows-1/step/SuccessCriteriaVisitor.ts and the name of visitor should be SuccessCriteriaVisitor.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks - nice spot.

packages/apidom-ns-workflows-1/src/refractor/visitors/workflows-1/step/ParametersVisitor.ts Outdated
import StepParametersElement from '../../../../elements/nces/StepParameters';
import BaseParametersVisitor from '../ParametersVisitor';

const ParametersVisitor = stampit(BaseParametersVisitor, {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need for doing this. There is only one Parameter Object list inside the spec. The BaseParameterVisitor, should be merged into this file: https://github.com/swagger-api/apidom/pull/3471/files#diff-2c8b689e039b2987e9c7a4e8ae33567fa4edcbb89f72cc2f5d614c57927cf873

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes applied - thanks

char0n
char0n approved these changes Dec 1, 2023
View reviewed changes
Copy link
Member

@char0n char0n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I'll follow up with one small change.

packages/apidom-ns-workflows-1/test/refractor/elements/Step/index.ts
'https://petstore3.swagger.io/api/v3/openapi.json#/paths/users/~findbystatus~1{status}/get',
workflowId: 'uniqueWorkflowId',
parameters: [
{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing Reference Object test. I'll follow up with a small change.

@char0n char0n merged commit c63021e into swagger-api:main Dec 1, 2023
8 checks passed
@frankkilcommins frankkilcommins deleted the ns-workflows-1-steps branch December 13, 2023 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@char0n char0n char0n approved these changes

Assignees

@char0n char0n

Labels
ApiDOM enhancement New feature or request Workflows Workflows specification
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@frankkilcommins @char0n