X-Flow-type
This extension allows you to work with types using your OpenAPI document.
Example
1 x-flow-type:
2 name: AddTrackRequest
3 customProperties:
4 playlist_id: string
Properties
| Property | Description |
|---|---|
| name | The name of the type, in cases where the type is contained within the Components section of the schema this will usually match the Component key. |
1 TrackRestrictionObject:
2 x-flow-type:
3 name: TrackRestrictionObject
In cases where the type is defined as a requestBody or response, this key is the only place where a name for this object will be present.
| Property | Description |
|---|---|
| customProperties | Defines custom properties along with a primitive type which will be added to the type definition when the type is imported into Flow. For example, this could be used where you need to add a track to a playlist, but in order to do so you need both the playlist_id and the track ids present on the given type. |
By adding this custom property and populating it with the correct value during the Flow's execution, the AddTrackRequest will be successful.
|
