Class: V1::WorkflowResource

Inherits:

JSONAPI::Resource

• Object
• JSONAPI::Resource
• V1::WorkflowResource

Defined in:

app/resources/v1/workflow_resource.rb

Overview

Note:

Access this resource via the /v1/workflows endpoint.

Provides a JSON:API representation of Workflow.

For more information about JSON:API see the JSON:API Specifications or look at the JSONAPI::Resources package for the service implementation of the JSON:API standard.

Primary Relationships: * workflow_steps { V1::WorkflowStep }

Examples:

curl -X GET http://localhost:3100/v1/workflows/1
curl -X GET http://localhost:3100/v1/workflows/
curl -X GET "http://localhost:3100/v1/workflows?include=workflow_steps"

Instance Attribute Summary

• #name ⇒ String

  The name of the workflow.

• #pipeline ⇒ String

  The pipeline of the workflow.

Instance Attribute Details

#name ⇒ String

Returns the name of the workflow.

Returns:

• (String) —

  the name of the workflow

# File 'app/resources/v1/workflow_resource.rb', line 24

attributes :name, :pipeline

#pipeline ⇒ String

Returns the pipeline of the workflow.

Returns:

• (String) —

  the pipeline of the workflow

# File 'app/resources/v1/workflow_resource.rb', line 24

attributes :name, :pipeline