Showing results for 
Search instead for 
Did you mean: 

workflow statuses

New Contributor

workflow statuses

Re: API design workflow and collaboration

Is there best practice for tagging an API with a status to help alert the team with the progress and trigger required actions through the API lifecycle? For example, in lieu of embedding the status in a comment, is there a way to set a "status" property, such as Review-in-progress, Design-complete, Testing-complete, Coding-complete, etc?




Re: workflow statuses

Hi there, good question.  There are a couple things in play that could affect the answer.


First, and working backwards, marking the API design as `published` is the best way to say "done".


Next, there is no "official status field" inside the definition structure, but I have found the info/description field to be the best place to put "in your face" status.  You can use Markdown to make bold, or even to embed an image in the description, which could indicate the status in your workflow.


Finally, comments and resolution of comments is a good way to indicate state (I know you said in lieu of comments, but just saying).  You can use them as sign-off based on different needs.


I hope that helps, and please post back any other questions or details of your needs.

Tony Tam
SmartBear VP of Swagger Products
New Contributor

Re: workflow statuses

Thanks Tony, that helps!

New Here?
Join us and watch the welcome video: