Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/windmill/windmill-api/types/ObservableAPI.ts>ObservableScriptApi

Windmill deno client (separated from the main repo because most of the code is auto-generated from the openapi and not worth committing)
windmill-labs/windmill-deno-client
Very Popular
Go to Latest
class ObservableScriptApi
import { ObservableScriptApi } from "https://deno.land/x/windmill@v1.38.0/windmill-api/types/ObservableAPI.ts";

Constructors

new
ObservableScriptApi(
configuration: Configuration,
requestFactory?: ScriptApiRequestFactory,
responseProcessor?: ScriptApiResponseProcessor,
)

Properties

private
configuration: Configuration
private
requestFactory: ScriptApiRequestFactory
private
responseProcessor: ScriptApiResponseProcessor

Methods

archiveScriptByHash(
workspace: string,
hash: string,
_options?: Configuration,
): Observable<Script>

archive script by hash

archiveScriptByPath(
workspace: string,
path: string,
_options?: Configuration,
): Observable<string>

archive script by path

createScript(
workspace: string,
inlineObject15: InlineObject15,
_options?: Configuration,
): Observable<string>

create script

deleteScriptByHash(
workspace: string,
hash: string,
_options?: Configuration,
): Observable<Script>

delete script by hash (erase content but keep hash)

denoToJsonschema(body: string, _options?: Configuration): Observable<MainArgSignature>

inspect deno code to infer jsonschema of arguments

existsScriptByPath(
workspace: string,
path: string,
_options?: Configuration,
): Observable<boolean>

exists script by path

getHubScriptContentByPath(path: string, _options?: Configuration): Observable<string>

get hub script content by path

getScriptByHash(
workspace: string,
hash: string,
_options?: Configuration,
): Observable<Script>

get script by hash

getScriptByPath(
workspace: string,
path: string,
_options?: Configuration,
): Observable<Script>

get script by path

getScriptDeploymentStatus(
workspace: string,
hash: string,
_options?: Configuration,
): Observable<InlineResponse2005>

get script deployment status

goToJsonschema(body: string, _options?: Configuration): Observable<MainArgSignature>

inspect go code to infer jsonschema of arguments

listHubScripts(_options?: Configuration): Observable<InlineResponse2002>

list all available hub scripts

listScripts(
workspace: string,
page?: number,
perPage?: number,
orderDesc?: boolean,
createdBy?: string,
pathStart?: string,
pathExact?: string,
firstParentHash?: string,
lastParentHash?: string,
parentHash?: string,
showArchived?: boolean,
isTemplate?: boolean,
kind?: string,
_options?: Configuration,
): Observable<Array<Script>>

list all available scripts

pythonToJsonschema(body: string, _options?: Configuration): Observable<MainArgSignature>

inspect python code to infer jsonschema of arguments

rawScriptByHash(
workspace: string,
path: string,
_options?: Configuration,
): Observable<string>

raw script by hash

rawScriptByPath(
workspace: string,
path: string,
_options?: Configuration,
): Observable<string>

raw script by path