Sign in
Pool API

Submit Workflow

Changed on

This api validates that a workflow is well formed and valid and then submits it.

post/api/pool/{pool_name}/workflow

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

pool_namestring required

Query parameters

workflow_idstring nullable
app_uuidstring nullable
app_versioninteger nullable
dry_runboolean
validation_onlyboolean
priority'HIGH' | 'NORMAL' | 'LOW'

Scheduling priority for workflows

env_varsstring[]
labelstring[]

Headers

x-osmo-userstring nullable
x-osmo-rolesstring nullable

Request body

filestring required
set_variablesstring[]
set_string_variablesstring[]
uploaded_templated_specstring nullable

Response

Successful Response

namestring required
overviewstring nullable
logsstring nullable
specstring nullable
dashboard_urlstring nullable
warningsstring[]

Changes

  • b9d312a13f5dRevision changes
    • ○

      added the new optional query request parameter label

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property to the response with the status

  • a8157dc3279dRevision changes
    • ▲

      the request's body type changed from object to no type

    • ▲

      the query request parameter priority was restricted to a list of enum values

    • ▲

      response property dashboard_url list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property logs list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property overview list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property spec list-of-types was widened by adding types null to media type application/json of response 200

    • ●

      removed the request property

    • ●

      removed the request property

    • ●

      removed the request property

    • ●

      removed the request property

    • ○

      added subschema #2 to the request body anyOf list

    • ○

      added the new enum value HIGH to the query request parameter priority

    • ○

      added the new enum value LOW to the query request parameter priority

    • ○

      added the new enum value NORMAL to the query request parameter priority

    • ○

      header request parameter x-osmo-roles list-of-types was widened by adding types null

    • ○

      header request parameter x-osmo-user list-of-types was widened by adding types null

    • ○

      query request parameter app_uuid list-of-types was widened by adding types null

    • ○

      query request parameter app_version list-of-types was widened by adding types null

    • ○

      query request parameter workflow_id list-of-types was widened by adding types null

    • ○

      for the header request parameter x-osmo-roles, the type was generalized from string to no type

    • ○

      for the header request parameter x-osmo-user, the type was generalized from string to no type

    • ○

      for the query request parameter app_uuid, the type was generalized from string to no type

    • ○

      for the query request parameter app_version, the type was generalized from integer to no type

    • ○

      for the query request parameter priority, the type was generalized from no type to string

    • ○

      for the query request parameter workflow_id, the type was generalized from string to no type