Skip to main content
ZStack
Infrastructure/OTA Upgrade Plans

TopologySort

Calculate the topological ordering of component dependencies for upgrade

POST/api/v1/lifecycle/upgrade-plans/{planId}/topology-sort

Operation ID

TopologySort

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • planId
    StringRequired

    ID of the upgrade plan this topology sort applies to

Body Fields

  • nodes
    ListRequired

    Nodes for this resource

    Example: (nested array)

    • name
      String

      Name of this component node

      Example: zcf-core

    • dependencies
      List

      Dependencies for this resource

      Example: item1,item2

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • order
    List

    Order for this resource

    Example: item1,item2

  • hasCycle
    Boolean

    Whether a circular dependency cycle was detected in the graph

    Example: false

  • cycle
    List

    Cycle for this resource

    Example: item1,item2