Skip to content

Latest commit

 

History

History
133 lines (86 loc) · 3.06 KB

GridGeneratorExtension.md

File metadata and controls

133 lines (86 loc) · 3.06 KB

StableSwarmUI API Documentation - GridGeneratorExtension

This is a subset of the API docs, see /docs/API.md for general info.

(CLASS DESCRIPTION NOT SET)

Table of Contents:

HTTP Route /API/GridGenDeleteData

Description

(ROUTE DESCRIPTION NOT SET)

Parameters

Name Type Description Default
gridName String (PARAMETER DESCRIPTION NOT SET) (REQUIRED)

Return Format

(RETURN INFO NOT SET)

HTTP Route /API/GridGenDoesExist

Description

(ROUTE DESCRIPTION NOT SET)

Parameters

Name Type Description Default
folderName String (PARAMETER DESCRIPTION NOT SET) (REQUIRED)

Return Format

(RETURN INFO NOT SET)

HTTP Route /API/GridGenGetData

Description

(ROUTE DESCRIPTION NOT SET)

Parameters

Name Type Description Default
gridName String (PARAMETER DESCRIPTION NOT SET) (REQUIRED)

Return Format

(RETURN INFO NOT SET)

HTTP Route /API/GridGenListData

Description

(ROUTE DESCRIPTION NOT SET)

Parameters

None.

Return Format

(RETURN INFO NOT SET)

WebSocket Route /API/GridGenRun

Description

(ROUTE DESCRIPTION NOT SET)

Parameters

Name Type Description Default
raw JObject (PARAMETER DESCRIPTION NOT SET) (REQUIRED)
outputFolderName String (PARAMETER DESCRIPTION NOT SET) (REQUIRED)
doOverwrite Boolean (PARAMETER DESCRIPTION NOT SET) (REQUIRED)
fastSkip Boolean (PARAMETER DESCRIPTION NOT SET) (REQUIRED)
generatePage Boolean (PARAMETER DESCRIPTION NOT SET) (REQUIRED)
publishGenMetadata Boolean (PARAMETER DESCRIPTION NOT SET) (REQUIRED)
dryRun Boolean (PARAMETER DESCRIPTION NOT SET) (REQUIRED)
weightOrder Boolean (PARAMETER DESCRIPTION NOT SET) (REQUIRED)
outputType String (PARAMETER DESCRIPTION NOT SET) (REQUIRED)
continueOnError Boolean (PARAMETER DESCRIPTION NOT SET) (REQUIRED)
showOutputs Boolean (PARAMETER DESCRIPTION NOT SET) (REQUIRED)

Return Format

(RETURN INFO NOT SET)

HTTP Route /API/GridGenSaveData

Description

(ROUTE DESCRIPTION NOT SET)

Parameters

Name Type Description Default
gridName String (PARAMETER DESCRIPTION NOT SET) (REQUIRED)
isPublic Boolean (PARAMETER DESCRIPTION NOT SET) (REQUIRED)
rawData JObject (PARAMETER DESCRIPTION NOT SET) (REQUIRED)

Return Format

(RETURN INFO NOT SET)