@deepraxis/cli 0.2.1-dev.d54e526 → 0.2.1-dev.da8587f
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/COMMANDS.md +43 -1
- package/dist/praxis.js +2402 -40
- package/package.json +1 -1
package/dist/praxis.js
CHANGED
|
@@ -143,7 +143,7 @@ across all toolsets allowed.`
|
|
|
143
143
|
type: "array",
|
|
144
144
|
itemType: "object",
|
|
145
145
|
required: false,
|
|
146
|
-
description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or
|
|
146
|
+
description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search, browser, ticket, crm, canvas or cut. There is no binding by default; enabling one opens every public method of that service. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time."
|
|
147
147
|
},
|
|
148
148
|
{
|
|
149
149
|
name: "kind",
|
|
@@ -1218,6 +1218,37 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
|
|
|
1218
1218
|
}
|
|
1219
1219
|
]
|
|
1220
1220
|
},
|
|
1221
|
+
{
|
|
1222
|
+
resource: "agent.computers.files.convert",
|
|
1223
|
+
method: "create",
|
|
1224
|
+
summary: "Convert a Computer Document to PDF",
|
|
1225
|
+
description: `Convert an Office document (docx, doc, ppt, pptx, rtf, odt; up to 16 MiB) to PDF inside a platform-owned ephemeral document sandbox, whatever machine family the computer itself runs on. Returns base64 PDF bytes.
|
|
1226
|
+
|
|
1227
|
+
Praxis extension: the preview conversion endpoint. The browser never parses an untrusted document — LibreOffice runs only inside an ephemeral document-family sandbox and the converter instance is killed after use. The file stays tenant-owned; non-convertible types answer EXTENSION_NOT_CONVERTIBLE and a failed conversion answers CONVERSION_FAILED.`,
|
|
1228
|
+
http: "POST",
|
|
1229
|
+
path: "/agent/v1/computers/{computer_id}/files/convert",
|
|
1230
|
+
streaming: "no",
|
|
1231
|
+
pagination: false,
|
|
1232
|
+
pathParams: [
|
|
1233
|
+
{
|
|
1234
|
+
name: "computer_id",
|
|
1235
|
+
sdkName: "computer_id",
|
|
1236
|
+
description: "Computer id (cmp_...), as returned by computers.create or computers.list."
|
|
1237
|
+
}
|
|
1238
|
+
],
|
|
1239
|
+
query: [],
|
|
1240
|
+
body: {
|
|
1241
|
+
required: true,
|
|
1242
|
+
fields: [
|
|
1243
|
+
{
|
|
1244
|
+
name: "name",
|
|
1245
|
+
type: "string",
|
|
1246
|
+
required: true,
|
|
1247
|
+
description: "Name of the entry or object."
|
|
1248
|
+
}
|
|
1249
|
+
]
|
|
1250
|
+
}
|
|
1251
|
+
},
|
|
1221
1252
|
{
|
|
1222
1253
|
resource: "agent.computers.leases",
|
|
1223
1254
|
method: "delete",
|
|
@@ -6100,7 +6131,7 @@ file at the root of that directory.`
|
|
|
6100
6131
|
"allow"
|
|
6101
6132
|
],
|
|
6102
6133
|
required: false,
|
|
6103
|
-
description: "skip
|
|
6134
|
+
description: "skip skips while a previous run is still active; allow permits overlapping runs. When omitted, schedule triggers use skip and webhook triggers use allow."
|
|
6104
6135
|
},
|
|
6105
6136
|
{
|
|
6106
6137
|
name: "catchup_window_seconds",
|
|
@@ -6274,7 +6305,7 @@ file at the root of that directory.`
|
|
|
6274
6305
|
"allow"
|
|
6275
6306
|
],
|
|
6276
6307
|
required: false,
|
|
6277
|
-
description: "skip
|
|
6308
|
+
description: "skip skips while a previous run is still active; allow permits overlapping runs. When omitted, schedule triggers use skip and webhook triggers use allow."
|
|
6278
6309
|
},
|
|
6279
6310
|
{
|
|
6280
6311
|
name: "catchup_window_seconds",
|
|
@@ -10162,6 +10193,12 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10162
10193
|
type: "integer",
|
|
10163
10194
|
required: false,
|
|
10164
10195
|
description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write."
|
|
10196
|
+
},
|
|
10197
|
+
{
|
|
10198
|
+
name: "loudness",
|
|
10199
|
+
type: "object",
|
|
10200
|
+
required: false,
|
|
10201
|
+
description: "Loudness normalization target. Omitted, the export is normalized to -14 LUFS integrated and -1 dBTP true peak, the level short-video and streaming platforms play at; null renders without normalization. Normalization adds analysis and rendering work."
|
|
10165
10202
|
}
|
|
10166
10203
|
]
|
|
10167
10204
|
}
|
|
@@ -10170,7 +10207,7 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10170
10207
|
resource: "cut.projects.frames",
|
|
10171
10208
|
method: "list",
|
|
10172
10209
|
summary: "Render preview frames",
|
|
10173
|
-
description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution.
|
|
10210
|
+
description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. The response always includes warnings; FRAME_UNAVAILABLE means a source preview could not be obtained and an offline tile was drawn. Its message identifies a timeout, delivery capacity limit, or unavailable source and contains no source URL. Decode each image's base64 payload to save it. Codemode returns at most four images per call, so request at most four times when reviewing there.",
|
|
10174
10211
|
http: "GET",
|
|
10175
10212
|
path: "/cut/v1/projects/{project_id}/frames",
|
|
10176
10213
|
streaming: "no",
|
|
@@ -10244,6 +10281,57 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10244
10281
|
]
|
|
10245
10282
|
}
|
|
10246
10283
|
},
|
|
10284
|
+
{
|
|
10285
|
+
resource: "cut.projects.renders",
|
|
10286
|
+
method: "create",
|
|
10287
|
+
summary: "Create draft range render",
|
|
10288
|
+
description: "Render one interval of the timeline so you can hear or look at how that passage comes out, without publishing anything to a media library. Choose kind audio for the mixed soundtrack as an .m4a file, or kind video for a draft-quality .mp4 with picture and sound. from and to are seconds on the project clock and must satisfy 0 <= from < to, to <= the timeline duration, and to - from <= 120; a longer passage is requested in several 分段请求 ranges and joined by the caller. The result is a temporary file (purpose user_data) that expires 24 hours after it is stored and is never imported into a library, so it is not a deliverable and carries no cut-export tag. HTTP 202 only accepts the job; poll praxis.cut.renders.retrieve using the returned id until status is done or failed, then read url while it lasts. A draft also bills like a draft export, by rendered seconds. Each project runs at most 2 draft renders at a time, a budget separate from its exports; a third answers HTTP 429 CUT_BUSY and the same call succeeds once one finishes.",
|
|
10289
|
+
http: "POST",
|
|
10290
|
+
path: "/cut/v1/projects/{project_id}/renders",
|
|
10291
|
+
streaming: "no",
|
|
10292
|
+
pagination: false,
|
|
10293
|
+
pathParams: [
|
|
10294
|
+
{
|
|
10295
|
+
name: "project_id",
|
|
10296
|
+
sdkName: "project_id",
|
|
10297
|
+
description: "Project identifier returned by its create or list operation; use the id, not a display name."
|
|
10298
|
+
}
|
|
10299
|
+
],
|
|
10300
|
+
query: [],
|
|
10301
|
+
body: {
|
|
10302
|
+
required: true,
|
|
10303
|
+
fields: [
|
|
10304
|
+
{
|
|
10305
|
+
name: "kind",
|
|
10306
|
+
type: "string",
|
|
10307
|
+
enum: [
|
|
10308
|
+
"audio",
|
|
10309
|
+
"video"
|
|
10310
|
+
],
|
|
10311
|
+
required: true,
|
|
10312
|
+
description: "audio renders the mixed soundtrack alone as an .m4a file for listening; video renders a draft-quality .mp4 with picture and sound for looking at. An audio draft is the cheaper of the two and is what a loudness or mix measurement asks for."
|
|
10313
|
+
},
|
|
10314
|
+
{
|
|
10315
|
+
name: "from",
|
|
10316
|
+
type: "number",
|
|
10317
|
+
required: true,
|
|
10318
|
+
description: "Start of the interval in seconds on the project clock, inclusive. Must be less than to."
|
|
10319
|
+
},
|
|
10320
|
+
{
|
|
10321
|
+
name: "to",
|
|
10322
|
+
type: "number",
|
|
10323
|
+
required: true,
|
|
10324
|
+
description: "End of the interval in seconds on the project clock, exclusive. At most 120 seconds after from, and never beyond the timeline duration; a longer passage is requested as several ranges."
|
|
10325
|
+
},
|
|
10326
|
+
{
|
|
10327
|
+
name: "revision",
|
|
10328
|
+
type: "integer",
|
|
10329
|
+
required: false,
|
|
10330
|
+
description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write."
|
|
10331
|
+
}
|
|
10332
|
+
]
|
|
10333
|
+
}
|
|
10334
|
+
},
|
|
10247
10335
|
{
|
|
10248
10336
|
resource: "cut.projects",
|
|
10249
10337
|
method: "retrieveState",
|
|
@@ -10385,7 +10473,158 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10385
10473
|
resource: "cut.projects",
|
|
10386
10474
|
method: "execute",
|
|
10387
10475
|
summary: "Execute editing script",
|
|
10388
|
-
description: 'Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: `const t = AddTrack("video"); Insert(t, {type: "color", color: "#123456", start: 0, length: 3}); Print(t);`\n\n### Script function reference\n\nFunctions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.\n\n```ts\nGetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;\nGetItem(id: ClipId): ItemView;\nFindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];\nGetMedia(ref: MediaRef): MediaInfo;\nGetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];\nGetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];\nListTransitions(): TransitionInfo[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\nSetSpeed(id: ClipId, rate: number, o: { keep: "source" | "duration"; ripple?: boolean }): { length: number; sourceOut: number };\nDelete(id: ClipId, o?: { ripple?: boolean }): void;\nJoin(left: ClipId, right: ClipId, o: { length?: number; effect: TransitionInput }): JoinId;\nUpdateJoin(id: JoinId, patch: { length?: number; effect?: TransitionInput }): void;\nDeleteJoin(id: JoinId): void;\nSplit(id: ClipId, at: number): ClipId;\nTrim(id: ClipId, edge: "in" | "out", delta: number, o?: { ripple?: boolean }): void;\nMove(id: ClipId, start: number, track?: TrackId): void;\nRippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;\nAddTrack(kind: "video" | "audio" | "caption", init?: { name?: string }, index?: number): TrackId;\nUpdateTrack(id: TrackId, patch: TrackPatch): void;\nDeleteTrack(id: TrackId): void;\nSetSettings(patch: Partial<ProjectSettingsView>): void;\nAddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle>; maxChars?: number }): ClipId[];\nSetMarker(at: number, label: string): string;\nPrint(...values: unknown[]): void;\nPreview(at: number[]): void;\n```\n\n| Functions | Behavior and arguments |\n| --- | --- |\n| GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, playback, sourceIn/sourceOut, text and offline reason. GetTimeline returns duration, tracks (id, kind, name, index, locked, items), and joins (id, track, left, right, length in seconds, normalized effect). from/to and tracks narrow the items and joins; joins are selected by their overlap window. |\n| ListTransitions | Discover the shared validation catalog: each entry contains kind (effect ID), name, description and params. Each parameter has name, type (enum/number/integer), default, description, enum values or numeric min/max. Use the returned kind and parameter names inside effect. |\n| FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |\n| GetMedia | Read metadata for `{libraryId, assetId}` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |\n| GetTranscript, GetAnalysis | Read available transcript words or silence/filler/scenes segments. Transcript filter from/to is seconds; returned word and segment from/to values are source microseconds (divide by 1,000,000 for editing). Words contain text and optional speaker/filler; segments may include label/confidence. Request analysis first if unavailable. |\n| Insert, Update, Delete | Insert returns the new clip ID; Update changes supplied fields; Delete removes the clip. Optional ripple on Insert/Delete closes or opens space on the track. |\n| SetSpeed | Change video/audio rate in 0.25–4; keep is required. source preserves consumed source and changes length, duration preserves output length. Returns actual length and sourceOut in seconds. Optional ripple explicitly shifts same-track followers when keeping source; otherwise overlaps are rejected. |\n| Join, UpdateJoin, DeleteJoin | Join creates an overlap between two butt-adjacent visual clips on the same track and returns its ID. length defaults to 0.5 seconds; effect is required. The right clip and all same-track followers move left by length, shortening that track and potentially the project. UpdateJoin moves those followers by the difference in length; omitted fields are preserved. DeleteJoin moves them right to restore the butt cut. Other tracks stay in place. |\n| Split, Trim, Move | Split at a timeline position and return the new right-hand clip ID. Trim changes the in or out edge by delta seconds. Move sets the timeline start and optionally a new track. |\n| RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |\n| AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb and style as appropriate to track kind. |\n| SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |\n| AddCaptionsFromTranscript | Create captions from an audio/video clip\'s kept words. Optional maxChars is 1–1000, default 16; style updates the caption track. Returns caption IDs. |\n| SetMarker | Add a label at a timeline time and return its ID. |\n| Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result\'s frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |\n\n#### Joins between clips\n\nEndpoints may be video, image, text, color or shape; audio and caption are rejected. Require 0 < length < each endpoint\'s length. Each clip allows at most one incoming and one outgoing join; their summed lengths cannot exceed its length. Three-input overlaps, nonadjacent endpoints and cross-track joins are rejected with OPS_REJECTED. Read the rejection\'s code and message, shorten or remove conflicting joins, and retry the saved edit.\n\nTransitionInput is an object with kind plus the parameters returned by ListTransitions; omitted parameters use the catalog defaults. Unknown kinds and unknown or invalid parameters are rejected. Effects: dissolve (no parameters); dip (color black/white, default black); push and wipe (direction left/right/up/down, default left); wipe also has softness 0–1, default 0; iris has centerX/centerY 0–1, both default 0.5; blinds has integer count 2–64, default 8, and orientation vertical/horizontal, default vertical; blur has radius 0–100 pixels at 1080-pixel frame height, default 24. Join options and UpdateJoin patches accept only length and effect. Effect updates replace the effect object and apply defaults for omitted parameters.\n\nMinimal example on an existing visual track with adjacent clips left and right: `Print(ListTransitions()); const j = Join(left, right, {length: 0.5, effect: {kind: "dissolve"}}); Print(GetTimeline().joins); Preview([GetItem(right).start + 0.25]);` Use `UpdateJoin(j, {length: 0.8})` to adjust it in a later edit or `DeleteJoin(j)` to restore the cut. Preview uses server-rendered frames and includes joins. Per-clip transitionIn/transitionOut remain separate entrance/exit effects.\n\n#### Insert fields (ItemInit)\n\nEvery item requires `type` and `start`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.\n\n| type | Required fields beyond type/start | Optional fields |\n| --- | --- | --- |\n| video | media | length, sourceIn, playback, volumeDb, transform, fit, animate, transitionIn, transitionOut |\n| image | media, length | transform, fit, animate, transitionIn, transitionOut |\n| text | text, length | style, transform, reveal, animate, transitionIn, transitionOut |\n| color | color, length | transform, fill, animate, transitionIn, transitionOut |\n| shape | shape, length, width, height, fill | radius, stroke, transform, animate, transitionIn, transitionOut |\n| audio | media | length, sourceIn, playback, volumeDb, fadeIn, fadeOut |\n| caption | text, length | — |\n\nVideo tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is `{libraryId: string, assetId: string}` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.\n\n| Field | Value |\n| --- | --- |\n| transform | Partial `{x, y, scale, rotation, opacity, crop, blur}`. x/y are normalized canvas center coordinates (default 0.5); scale 1 is fitted size; rotation is degrees (default 0); opacity is 0–1 (default 1). crop is `{top,right,bottom,left}`. blur is 0–100 pixels at 1080-pixel frame height. |\n| style | Partial `{fontFamily, fontSize, fontWeight, color, stroke, background, align, maxWidth, position, margin}`. fontFamily: Geist or Noto Sans SC (default); fontSize defaults to 48; fontWeight: 400 (default), 500 or 700; color defaults to #FFFFFF; align: left, center (default), right; maxWidth is a fraction of canvas width (default 0.9). stroke is `{color,width}`. Text and captions support position (top/middle/bottom; box centers at 12%/50%/85% of height without margin) and optional margin (0–0.4 of canvas height, box edge distance for top/bottom; middle ignores it). Omitted position preserves the text transform (center by default); explicit position controls vertical placement, so omit it for y animation. Caption style additionally supports highlightColor and maxLines: 2. GetItem and GetTimeline return text style and current caption track style. Caption tracks only accept captions; use AddCaptionsFromTranscript, and place text on video tracks. |\n| animate | An object keyed by x, y, scale, rotation, opacity or blur. Each value is an array of `{at: number, value: number, ease?: Ease}` sorted by at with distinct frame-snapped times. Values hold before the first and after the last keyframe, overriding the static transform. |\n| Ease | linear, in, out, inOut, `{bezier: [x1,y1,x2,y2]}` or `{spring: {stiffness, damping, mass?}}`. Easing shapes the segment arriving at that keyframe; springs may overshoot. |\n| reveal | `{by, delay?: number, stagger: number, duration: number, from: {y?, opacity?, scale?, blur?}, ease?: Ease}`. by selects char, word or line. Unit k starts at delay + k * stagger and takes duration seconds to reach its resting state; from.y is a fraction of font size. |\n| fill | A color string (#RRGGBB or #RRGGBBAA), `{linear: {angle, stops: [{at,color}, ...]}}` or `{radial: {stops: [{at,color}, ...]}}`. Stop positions are 0–1; angle is degrees, 0 left to right. On color clips, fill replaces color when supplied. |\n| shape, width, height, radius, stroke | shape is rect or ellipse. width/height are fractions of canvas width/height before scaling. radius rounds rect corners in pixels at 1080-pixel frame height. stroke is `{color: string, width: number}`. |\n| transitionIn, transitionOut | `{kind, length: number}` at the clip\'s beginning/end. length is seconds. fade changes opacity; dissolve blends; push_left/push_right move horizontally; wipe_left reveals horizontally. |\n\n#### Update fields (ItemPatchView)\n\nAll fields are optional; use only fields relevant to the item\'s type. Supported fields: start, length, sourceIn, playback, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, animate, reveal, fill, stroke, shape, width, height, radius, transitionIn, transitionOut. Values and units match Insert. Set animate, reveal, fill, stroke, transitionIn or transitionOut to null to remove that effect; omitting a field preserves it. For example: `Update(id, {volumeDb: -12})` or `Update(id, {transitionIn: null})`.\n\n#### Speed, reverse and freeze\n\nVideo/audio Insert and Update accept playback as `{kind: "rate", rate: number, direction: "forward" | "reverse", audio: "preservePitch" | "resample" | "mute"}` or `{kind: "freeze"}`. Rate is finite and inclusive 0.25–4. Omitted playback defaults to 1× forward with preservePitch; supply the complete rate object when changing playback. preservePitch keeps pitch, resample changes pitch with speed, mute removes audio. Reverse requires explicit audio: "mute"; preservePitch/resample are rejected with UNSUPPORTED_PLAYBACK rather than silently muted. Freeze holds sourceIn and is silent. GetItem/GetTimeline echo playback and the source interval in seconds; sourceOut is exclusive even for reverse and equals sourceIn for freeze.\n\nUpdate of playback keeps output length unless length is also supplied. SetSpeed preserves direction/audio, rejects frozen and non-video/audio clips, and requires keep: "source" or "duration". keep: "source" computes round(consumed source / new rate × fps) frames, falling back to floor if rounding would exceed the source end; the returned length/sourceOut are actual frame-rounded seconds. keep: "duration" keeps output length and changes source consumption. Length conflicts fail with OVERLAP; move/shorten the conflicting clip, keep duration, or explicitly use ripple: true to shift following clips on the same track. Source overflow fails with OUT_OF_SOURCE; rate limits fail with RATE_OUT_OF_RANGE. Unknown playback fields and SetSpeed options are rejected with UNKNOWN_FIELD; options only accept keep and boolean ripple.\n\nExample for an existing four-second video/audio clip id: `Print(SetSpeed(id, 0.5, {keep: "source"})); Print(SetSpeed(id, 2, {keep: "source"}));` returns lengths 8 then 2, keeping the same source interval. Reverse: `Update(id, {playback: {kind: "rate", rate: 1, direction: "reverse", audio: "mute"}})`. Freeze: `Update(id, {playback: {kind: "freeze"}})`. Ensure enough source remains for the chosen length/rate. Browser reverse playback currently displays a placeholder; server-rendered Preview/frames and exports support reverse normally. Speed-adjusted audio is generated asynchronously after the edit transaction commits; exports wait for that audio before rendering.\n\n#### Script names versus HTTP response names\n\nUse camelCase inside scripts, including nested objects. HTTP request/response JSON outside script source uses snake_case. Map media.library_id → media.libraryId, media.asset_id → media.assetId, source_in → sourceIn, volume_db → volumeDb, fade_in/fade_out → fadeIn/fadeOut, transition_in/transition_out → transitionIn/transitionOut, font_family/font_size/font_weight/max_width → fontFamily/fontSize/fontWeight/maxWidth, gain_db → gainDb, highlight_color/max_lines → highlightColor/maxLines. Fields such as animate, reveal, fill, stroke, at and length retain their spelling. GetTimeline/GetItem already return camelCase compact views; the expanded retrieveTimeline HTTP response is not an Insert object.\n\nUnrecognized script fields fail with OPS_REJECTED and rejection code UNKNOWN_FIELD; snake_case mistakes suggest the corresponding camelCase name. The error message lists each rejection\'s #opIndex, code and reason. Correct the named fields and retry the saved edit; do not assume an ignored field applied an effect.\n',
|
|
10476
|
+
description: `Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: \`const t = AddTrack("video"); Insert(t, {type: "color", color: "#123456", start: 0, length: 3}); Print(t);\`
|
|
10477
|
+
|
|
10478
|
+
<!-- cut-reference:start -->
|
|
10479
|
+
### Script function, field and error reference
|
|
10480
|
+
|
|
10481
|
+
Every script function, clip field and error code has its own section, read one at a time:
|
|
10482
|
+
|
|
10483
|
+
\`\`\`
|
|
10484
|
+
codemode.describe("praxis.cut.script.<Name>") // one function: signature, arguments, return, errors, example
|
|
10485
|
+
codemode.describe("praxis.cut.fields.<name>") // one field: type, unit, range, default, where writable
|
|
10486
|
+
codemode.describe("praxis.cut.errors.<CODE>") // one code: meaning, causes, fix
|
|
10487
|
+
codemode.describe("praxis.cut.script") // names, one page at a time
|
|
10488
|
+
\`\`\`
|
|
10489
|
+
|
|
10490
|
+
Published at https://docs.deepraxis.com/docs/developers/cut/script-reference with one anchor per entry. Names below omit the \`praxis.cut.<kind>.\` prefix.
|
|
10491
|
+
|
|
10492
|
+
#### Script functions (script)
|
|
10493
|
+
|
|
10494
|
+
- \`GetTimeline\` — Duration, tracks, joins; clips are under \`items\`.
|
|
10495
|
+
- \`GetItem\` — One clip's compact view, by id.
|
|
10496
|
+
- \`FindItems\` — Visit every clip with its track; collect results.
|
|
10497
|
+
- \`GetMedia\` — Media metadata; \`durationUs\` is microseconds.
|
|
10498
|
+
- \`GetTranscript\` — Transcript words in source microseconds.
|
|
10499
|
+
- \`GetAnalysis\` — Silence, filler or scene segments.
|
|
10500
|
+
- \`ListTransitions\` — Join transition kinds and parameters.
|
|
10501
|
+
- \`ListEffects\` — Visual-effect catalog and parameters.
|
|
10502
|
+
- \`ListAnimations\` — Animation presets by phase and target.
|
|
10503
|
+
- \`ListFonts\` — Font families, weights and scripts.
|
|
10504
|
+
- \`ListTextStyles\` — Text style presets for \`style.preset\`.
|
|
10505
|
+
- \`ListTextTemplates\` — Multi-layer templates and their slots.
|
|
10506
|
+
- \`Insert\` — Add a clip; a track never overlaps itself.
|
|
10507
|
+
- \`Append\` — Add a clip at the end of a track.
|
|
10508
|
+
- \`Update\` — Change named fields; the rest stay.
|
|
10509
|
+
- \`SetSpeed\` — Change rate, keeping source or duration.
|
|
10510
|
+
- \`Delete\` — Remove a clip. There is no \`Remove\`.
|
|
10511
|
+
- \`Join\` — Overlap clips; followers shift, track shortens.
|
|
10512
|
+
- \`UpdateJoin\` — Change a join's length or effect.
|
|
10513
|
+
- \`DeleteJoin\` — Remove a join; restore the butt cut.
|
|
10514
|
+
- \`Split\` — Cut a clip in two at a time.
|
|
10515
|
+
- \`Trim\` — Move one clip edge by seconds.
|
|
10516
|
+
- \`Move\` — Set a clip's start or track.
|
|
10517
|
+
- \`RippleDeleteRange\` — Cut a time range and close the gap.
|
|
10518
|
+
- \`AddTrack\` — Add a video, audio or caption track.
|
|
10519
|
+
- \`UpdateTrack\` — Change a track's name, lock, gain or role.
|
|
10520
|
+
- \`DeleteTrack\` — Remove a track and its clips.
|
|
10521
|
+
- \`SetSettings\` — Change canvas, frame rate or background.
|
|
10522
|
+
- \`AddCaptionsFromTranscript\` — Captions from a clip's kept words.
|
|
10523
|
+
- \`InsertTemplate\` — Insert a template and fill its slots.
|
|
10524
|
+
- \`AlignCaptions\` — Rebuild captions from text punctuation.
|
|
10525
|
+
- \`ImportCaptions\` — Import SRT or WebVTT onto captions.
|
|
10526
|
+
- \`ExportCaptions\` — Export captions as SRT or WebVTT.
|
|
10527
|
+
- \`SetMarker\` — Label a timeline position.
|
|
10528
|
+
- \`Print\` — Append values to the result's \`prints\`.
|
|
10529
|
+
- \`Preview\` — Up to 8 frames as inline PNG data URLs.
|
|
10530
|
+
|
|
10531
|
+
#### Fields (fields)
|
|
10532
|
+
|
|
10533
|
+
- \`type\` — Clip kind; decides which fields apply.
|
|
10534
|
+
- \`start\` — Clip start in seconds; snaps to frames.
|
|
10535
|
+
- \`length\` — Duration; optional for video and audio.
|
|
10536
|
+
- \`media\` — Source \`{ libraryId, assetId }\`.
|
|
10537
|
+
- \`sourceIn\` — First source second kept; default 0.
|
|
10538
|
+
- \`sourceOut\` — Exclusive source end; read-only.
|
|
10539
|
+
- \`text\` — Text of a text or caption clip.
|
|
10540
|
+
- \`color\` — Solid colour of a color clip.
|
|
10541
|
+
- \`shape\` — Shape clip kind: \`rect\` or \`ellipse\`.
|
|
10542
|
+
- \`width\` — Shape width, a fraction of canvas width.
|
|
10543
|
+
- \`height\` — Shape height, a fraction of canvas height.
|
|
10544
|
+
- \`radius\` — Rect corner rounding, in 1080-height px.
|
|
10545
|
+
- \`fill\` — Shape or text paint: colour or gradient.
|
|
10546
|
+
- \`stroke\` — Shape outline: colour and width.
|
|
10547
|
+
- \`transform\` — Position, scale, rotation, opacity, crop, blur.
|
|
10548
|
+
- \`fit\` — contain, cover, fill or none.
|
|
10549
|
+
- \`blend\` — Layer blend mode; null clears.
|
|
10550
|
+
- \`style\` — Text styling: font, fill, strokes, glow, position.
|
|
10551
|
+
- \`style.position\` — top, middle or bottom; omit it, never null.
|
|
10552
|
+
- \`playback\` — Rate, direction, audio policy, or freeze.
|
|
10553
|
+
- \`volumeDb\` — Audio level in dB; 0 is source level.
|
|
10554
|
+
- \`gain\` — Keyframed audio level in dB.
|
|
10555
|
+
- \`fadeIn\` — Fade-in seconds at the clip's start.
|
|
10556
|
+
- \`fadeOut\` — Fade-out seconds at the clip's end.
|
|
10557
|
+
- \`duck\` — Lower this clip while another track plays.
|
|
10558
|
+
- \`animate\` — Transform keyframes; \`at\` is clip-relative seconds.
|
|
10559
|
+
- \`reveal\` — Per-character, word or line reveal timing.
|
|
10560
|
+
- \`animation\` — Preset slots \`{ in, out, loop }\`; null clears.
|
|
10561
|
+
- \`effects\` — Effect stack, at most 8; null clears.
|
|
10562
|
+
- \`transitionIn\` — Entrance effect: kind plus seconds.
|
|
10563
|
+
- \`transitionOut\` — Exit effect: kind plus seconds.
|
|
10564
|
+
- \`mask\` — Shape, path or track matte.
|
|
10565
|
+
- \`words\` — Caption words with clip-local times.
|
|
10566
|
+
|
|
10567
|
+
#### Error codes (errors)
|
|
10568
|
+
|
|
10569
|
+
- \`JOIN_CONFLICT\` — A join is invalid or blocks this edit.
|
|
10570
|
+
- \`INVALID_TRANSITION\` — Bad transition kind, parameter or length.
|
|
10571
|
+
- \`INVALID_STYLE\` — A style value is out of range.
|
|
10572
|
+
- \`INVALID_MASK\` — A mask definition is malformed.
|
|
10573
|
+
- \`MASK_IN_USE\` — The edit would break a live mask.
|
|
10574
|
+
- \`TOO_MANY_MASKS\` — At most 16 masks per project.
|
|
10575
|
+
- \`RATE_OUT_OF_RANGE\` — A rate is outside 0.25-4.
|
|
10576
|
+
- \`UNSUPPORTED_PLAYBACK\` — Reverse without an explicit mute.
|
|
10577
|
+
- \`INVALID_PLAYBACK\` — A playback object is partial or malformed.
|
|
10578
|
+
- \`UNKNOWN_FONT\` — The family is not in \`ListFonts()\`.
|
|
10579
|
+
- \`UNKNOWN_FIELD\` — The field name is not accepted here.
|
|
10580
|
+
- \`UNKNOWN_TEXT_STYLE\` — \`style.preset\` is not in the catalog.
|
|
10581
|
+
- \`TEXT_STYLE_TARGET_MISMATCH\` — Preset on the wrong clip type.
|
|
10582
|
+
- \`CAPTION_ALIGN_LOW_CONFIDENCE\` — Alignment confidence too low; nothing changed.
|
|
10583
|
+
- \`OVERLAP\` — Two clips on one track would share time.
|
|
10584
|
+
- \`OUT_OF_SOURCE\` — The clip would read past its source.
|
|
10585
|
+
- \`LOCKED_TRACK\` — The edit targets a locked track.
|
|
10586
|
+
- \`UNBOUND_LIBRARY\` — The library is not bound to the project.
|
|
10587
|
+
- \`TRACK_KIND_MISMATCH\` — The clip type does not fit the track.
|
|
10588
|
+
- \`NOT_FOUND\` — The named id is not in this project.
|
|
10589
|
+
- \`TOO_SHORT\` — The result would be under one frame.
|
|
10590
|
+
- \`INVALID_DUCK\` — Bad \`duck\` level or a missing track.
|
|
10591
|
+
- \`UNKNOWN_ANIMATION\` — The preset is not in \`ListAnimations()\`.
|
|
10592
|
+
- \`INVALID_ANIMATION_PARAM\` — Bad slot, parameter or keyframe limit.
|
|
10593
|
+
- \`ANIMATION_TOO_LONG\` — In plus out exceed the clip length.
|
|
10594
|
+
- \`ANIMATION_TARGET_MISMATCH\` — The preset does not match the clip type.
|
|
10595
|
+
- \`ANIMATION_PHASE_MISMATCH\` — The preset is in the wrong slot.
|
|
10596
|
+
- \`UNKNOWN_EFFECT\` — The effect is not in \`ListEffects()\`.
|
|
10597
|
+
- \`INVALID_EFFECT_PARAM\` — Bad effect parameter or keyframe.
|
|
10598
|
+
- \`TOO_MANY_EFFECTS\` — More than 8 effects on one clip.
|
|
10599
|
+
- \`PROJECT_NOT_FOUND\` — No visible project has this id.
|
|
10600
|
+
- \`EXPORT_NOT_FOUND\` — No such export in this project.
|
|
10601
|
+
- \`VERSION_NOT_FOUND\` — No saved version has this revision.
|
|
10602
|
+
- \`LIBRARY_NOT_FOUND\` — The library is missing or invisible.
|
|
10603
|
+
- \`BINDING_INVALID\` — The binding request is malformed.
|
|
10604
|
+
- \`BINDING_IN_USE\` — Clips still use this library's assets.
|
|
10605
|
+
- \`NOTHING_TO_UNDO\` — No earlier revision to return to.
|
|
10606
|
+
- \`NOTHING_TO_REDO\` — No undone revision is waiting.
|
|
10607
|
+
- \`UNDO_CONFLICT\` — The revision to undo is no longer head.
|
|
10608
|
+
- \`REVISION_CONFLICT\` — The project moved; your revision is stale.
|
|
10609
|
+
- \`CUT_BUSY\` — The project is busy; retry.
|
|
10610
|
+
- \`INVALID_CAPTION_FILE\` — The subtitle file is malformed or too big.
|
|
10611
|
+
- \`SCRIPT_ERROR\` — The script threw or did not parse.
|
|
10612
|
+
- \`SCRIPT_LIMIT\` — An execute budget was exceeded.
|
|
10613
|
+
- \`OPS_REJECTED\` — An op failed; the whole edit rolled back.
|
|
10614
|
+
- \`EDIT_EXPIRED\` — The saved edit id is over ten minutes old.
|
|
10615
|
+
- \`MEDIA_OFFLINE\` — The asset cannot be fetched right now.
|
|
10616
|
+
- \`MEDIA_UNAVAILABLE\` — The asset is not usable for rendering.
|
|
10617
|
+
- \`MEDIA_IMPORT_FAILED\` — Importing media failed.
|
|
10618
|
+
- \`FRAME_OUT_OF_RANGE\` — The preview time is outside the project.
|
|
10619
|
+
- \`PROJECT_TOO_LARGE\` — The project exceeds the size limit.
|
|
10620
|
+
- \`RESPONSE_TOO_LARGE\` — The response would exceed its budget.
|
|
10621
|
+
- \`EXPORT_FAILED\` — The render failed; read \`error.cause\`.
|
|
10622
|
+
- \`INVALID_PARAMS\` — The request is malformed.
|
|
10623
|
+
- \`PERMISSION_DENIED\` — This credential may not do that here.
|
|
10624
|
+
- \`NOT_IMPLEMENTED\` — Not available on this platform yet.
|
|
10625
|
+
- \`INTERNAL\` — Unexpected failure; retry with the request id.
|
|
10626
|
+
<!-- cut-reference:end -->
|
|
10627
|
+
`,
|
|
10389
10628
|
http: "POST",
|
|
10390
10629
|
path: "/cut/v1/projects/{project_id}:execute",
|
|
10391
10630
|
streaming: "no",
|
|
@@ -10447,6 +10686,24 @@ Execution errors include error.details.prints containing output printed before f
|
|
|
10447
10686
|
],
|
|
10448
10687
|
query: []
|
|
10449
10688
|
},
|
|
10689
|
+
{
|
|
10690
|
+
resource: "cut.renders",
|
|
10691
|
+
method: "retrieve",
|
|
10692
|
+
summary: "Retrieve draft range render",
|
|
10693
|
+
description: "Poll a draft render id returned by projects.renders.create to see whether the interval is ready, then read url while it lasts. queued and rendering are in progress; done provides file_id and a short-lived url for the rendered .m4a or .mp4; failed provides error. Only done yields a url, and the file behind it disappears 24 hours after it was stored, so retrieve again when the link has expired.",
|
|
10694
|
+
http: "GET",
|
|
10695
|
+
path: "/cut/v1/renders/{render_id}",
|
|
10696
|
+
streaming: "no",
|
|
10697
|
+
pagination: false,
|
|
10698
|
+
pathParams: [
|
|
10699
|
+
{
|
|
10700
|
+
name: "render_id",
|
|
10701
|
+
sdkName: "render_id",
|
|
10702
|
+
description: "Draft render id (cutr_…) returned by projects.renders.create."
|
|
10703
|
+
}
|
|
10704
|
+
],
|
|
10705
|
+
query: []
|
|
10706
|
+
},
|
|
10450
10707
|
{
|
|
10451
10708
|
resource: "cut.versions",
|
|
10452
10709
|
method: "restore",
|
|
@@ -11419,6 +11676,674 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11419
11676
|
]
|
|
11420
11677
|
}
|
|
11421
11678
|
},
|
|
11679
|
+
{
|
|
11680
|
+
resource: "devops.projects.testCases",
|
|
11681
|
+
method: "list",
|
|
11682
|
+
summary: "List test cases",
|
|
11683
|
+
description: "List a project's cases with their health, state and recent statistics, so you can decide which ones a plan must run and which are quarantined. This is the read a test dashboard is built on; filter it to narrow by state or health instead of paging through everything. A case's id is a fingerprint of its own title and path, so it survives a rename — read aliases when reconciling history recorded under an older title.",
|
|
11684
|
+
http: "GET",
|
|
11685
|
+
path: "/devops/v1/projects/{project}/test-cases",
|
|
11686
|
+
streaming: "no",
|
|
11687
|
+
pagination: false,
|
|
11688
|
+
pathParams: [
|
|
11689
|
+
{
|
|
11690
|
+
name: "project",
|
|
11691
|
+
sdkName: "project",
|
|
11692
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
11693
|
+
}
|
|
11694
|
+
],
|
|
11695
|
+
query: [
|
|
11696
|
+
{
|
|
11697
|
+
name: "pageSize",
|
|
11698
|
+
type: "integer",
|
|
11699
|
+
required: false,
|
|
11700
|
+
description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone."
|
|
11701
|
+
},
|
|
11702
|
+
{
|
|
11703
|
+
name: "pageToken",
|
|
11704
|
+
type: "string",
|
|
11705
|
+
required: false,
|
|
11706
|
+
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
11707
|
+
},
|
|
11708
|
+
{
|
|
11709
|
+
name: "filter",
|
|
11710
|
+
type: "string",
|
|
11711
|
+
required: false,
|
|
11712
|
+
description: "AIP-160 equality filter over one declared field at a time, for example state=quarantined or health=broken. Fields a case list does not declare are refused with INVALID_ARGUMENT rather than ignored, so a typo never silently widens the result."
|
|
11713
|
+
},
|
|
11714
|
+
{
|
|
11715
|
+
name: "orderBy",
|
|
11716
|
+
type: "string",
|
|
11717
|
+
required: false,
|
|
11718
|
+
description: "Comma-separated fields to order by, each optionally suffixed with desc, for example createTime desc. Only the fields the resource declares are accepted; anything else is refused so an ordering typo cannot silently return a different order. Omitted uses the resource's own order."
|
|
11719
|
+
}
|
|
11720
|
+
]
|
|
11721
|
+
},
|
|
11722
|
+
{
|
|
11723
|
+
resource: "devops.projects",
|
|
11724
|
+
method: "retrieveTestCatalog",
|
|
11725
|
+
summary: "Read a commit's test catalog",
|
|
11726
|
+
description: 'Read the catalog version discovered at one commit — how many suites and cases it holds, which frameworks they come from, and how the commit changed them. Call this first: it tells you which suites, cases and sizes exist before you list them or select them into a plan, and the reported diff explains why a case count moved. A commit whose discovery has not finished answers CATALOG_NOT_READY, which means "not yet", not "no tests"; wait and read again. Omit commit to read the newest catalog published for the project.',
|
|
11727
|
+
http: "GET",
|
|
11728
|
+
path: "/devops/v1/projects/{project}/test-catalog",
|
|
11729
|
+
streaming: "no",
|
|
11730
|
+
pagination: false,
|
|
11731
|
+
pathParams: [
|
|
11732
|
+
{
|
|
11733
|
+
name: "project",
|
|
11734
|
+
sdkName: "project",
|
|
11735
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
11736
|
+
}
|
|
11737
|
+
],
|
|
11738
|
+
query: [
|
|
11739
|
+
{
|
|
11740
|
+
name: "commit",
|
|
11741
|
+
type: "string",
|
|
11742
|
+
required: false,
|
|
11743
|
+
description: "Full 40-character commit sha whose catalog you want, from a project branch or commit read. Omit it to read the newest catalog published for the project."
|
|
11744
|
+
}
|
|
11745
|
+
]
|
|
11746
|
+
},
|
|
11747
|
+
{
|
|
11748
|
+
resource: "devops.projects.testPlans",
|
|
11749
|
+
method: "list",
|
|
11750
|
+
summary: "List test plans",
|
|
11751
|
+
description: "List the project's plans — what each one selects, which stage and gate it belongs to, and when it runs next. Read this before creating a plan, so a new plan extends what exists instead of duplicating a selector an existing plan already covers.",
|
|
11752
|
+
http: "GET",
|
|
11753
|
+
path: "/devops/v1/projects/{project}/test-plans",
|
|
11754
|
+
streaming: "no",
|
|
11755
|
+
pagination: false,
|
|
11756
|
+
pathParams: [
|
|
11757
|
+
{
|
|
11758
|
+
name: "project",
|
|
11759
|
+
sdkName: "project",
|
|
11760
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
11761
|
+
}
|
|
11762
|
+
],
|
|
11763
|
+
query: [
|
|
11764
|
+
{
|
|
11765
|
+
name: "pageSize",
|
|
11766
|
+
type: "integer",
|
|
11767
|
+
required: false,
|
|
11768
|
+
description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone."
|
|
11769
|
+
},
|
|
11770
|
+
{
|
|
11771
|
+
name: "pageToken",
|
|
11772
|
+
type: "string",
|
|
11773
|
+
required: false,
|
|
11774
|
+
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
11775
|
+
},
|
|
11776
|
+
{
|
|
11777
|
+
name: "orderBy",
|
|
11778
|
+
type: "string",
|
|
11779
|
+
required: false,
|
|
11780
|
+
description: "Comma-separated fields to order by, each optionally suffixed with desc, for example createTime desc. Only the fields the resource declares are accepted; anything else is refused so an ordering typo cannot silently return a different order. Omitted uses the resource's own order."
|
|
11781
|
+
}
|
|
11782
|
+
]
|
|
11783
|
+
},
|
|
11784
|
+
{
|
|
11785
|
+
resource: "devops.projects.testPlans",
|
|
11786
|
+
method: "create",
|
|
11787
|
+
summary: "Create a test plan",
|
|
11788
|
+
description: "Create a plan that decides which cases a stage must run. The plan's key is unique inside the project and is what a later run names; the selector chooses cases by size, purpose, tag, package or explicit ids, and the trigger says when the plan fires by itself. A merge or promotion gate must name the environment it guards, and a plan with a gate but no environment is refused with PLAN_GATE_ENVIRONMENT_MISMATCH rather than created and silently ignored. A plan has no revision history: update it with a patch.",
|
|
11789
|
+
http: "POST",
|
|
11790
|
+
path: "/devops/v1/projects/{project}/test-plans",
|
|
11791
|
+
streaming: "no",
|
|
11792
|
+
pagination: false,
|
|
11793
|
+
pathParams: [
|
|
11794
|
+
{
|
|
11795
|
+
name: "project",
|
|
11796
|
+
sdkName: "project",
|
|
11797
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
11798
|
+
}
|
|
11799
|
+
],
|
|
11800
|
+
query: [],
|
|
11801
|
+
body: {
|
|
11802
|
+
required: true,
|
|
11803
|
+
fields: [
|
|
11804
|
+
{
|
|
11805
|
+
name: "key",
|
|
11806
|
+
type: "string",
|
|
11807
|
+
required: true,
|
|
11808
|
+
description: "Short name for the plan, unique inside the project; a key already in use is refused rather than silently reused."
|
|
11809
|
+
},
|
|
11810
|
+
{
|
|
11811
|
+
name: "title",
|
|
11812
|
+
type: "string",
|
|
11813
|
+
required: true,
|
|
11814
|
+
description: "Display title of the plan, shown wherever the plan is listed."
|
|
11815
|
+
},
|
|
11816
|
+
{
|
|
11817
|
+
name: "stage",
|
|
11818
|
+
type: "string",
|
|
11819
|
+
enum: [
|
|
11820
|
+
"dev",
|
|
11821
|
+
"presubmit",
|
|
11822
|
+
"postsubmit",
|
|
11823
|
+
"nightly",
|
|
11824
|
+
"production"
|
|
11825
|
+
],
|
|
11826
|
+
required: true,
|
|
11827
|
+
description: "Which stage of delivery this plan belongs to, which decides when it is expected to run."
|
|
11828
|
+
},
|
|
11829
|
+
{
|
|
11830
|
+
name: "trigger",
|
|
11831
|
+
type: "object",
|
|
11832
|
+
required: true,
|
|
11833
|
+
description: "What starts a run of this plan. Exactly one kind applies; the fields a kind needs are the ones it carries."
|
|
11834
|
+
},
|
|
11835
|
+
{
|
|
11836
|
+
name: "selector",
|
|
11837
|
+
type: "object",
|
|
11838
|
+
required: true,
|
|
11839
|
+
description: "Which cases a plan or run selects. Every member is optional and they combine as an intersection, so a selector with no member selects every case in the catalog."
|
|
11840
|
+
},
|
|
11841
|
+
{
|
|
11842
|
+
name: "environment",
|
|
11843
|
+
type: "string",
|
|
11844
|
+
required: false,
|
|
11845
|
+
description: "The environment this plan runs against; required by a merge or promotion gate, and refused with PLAN_GATE_ENVIRONMENT_MISMATCH when it disagrees with the gate."
|
|
11846
|
+
},
|
|
11847
|
+
{
|
|
11848
|
+
name: "gate",
|
|
11849
|
+
type: "string",
|
|
11850
|
+
enum: [
|
|
11851
|
+
"merge",
|
|
11852
|
+
"promotion",
|
|
11853
|
+
"observation",
|
|
11854
|
+
"none"
|
|
11855
|
+
],
|
|
11856
|
+
required: true,
|
|
11857
|
+
description: "Whether this plan's result blocks a stage; a merge or promotion gate must name its environment."
|
|
11858
|
+
},
|
|
11859
|
+
{
|
|
11860
|
+
name: "repeat",
|
|
11861
|
+
type: "integer",
|
|
11862
|
+
required: false,
|
|
11863
|
+
description: "How many times each selected case runs in one run; omit for once. More than one is how a flake is told apart from a real failure."
|
|
11864
|
+
},
|
|
11865
|
+
{
|
|
11866
|
+
name: "timeoutMinutes",
|
|
11867
|
+
type: "integer",
|
|
11868
|
+
required: false,
|
|
11869
|
+
description: "How many minutes a run of this plan may take before it is timed out; omit for the service's default."
|
|
11870
|
+
}
|
|
11871
|
+
]
|
|
11872
|
+
}
|
|
11873
|
+
},
|
|
11874
|
+
{
|
|
11875
|
+
resource: "devops.projects.testReports",
|
|
11876
|
+
method: "create",
|
|
11877
|
+
summary: "Upload an external test report",
|
|
11878
|
+
description: "Record the results of a run executed outside Praxis by uploading a CTRF or JUnit report. The report is folded into the run named by ref and the run's counts and verdict are recomputed from it. Uploading the same reportId again is idempotent and counts once, so a retry after a timeout is safe; a different reportId for the same run adds its results. Pass the run you created with executor external — a report for a run that does not exist is NOT_FOUND, never silently recorded against another run.",
|
|
11879
|
+
http: "POST",
|
|
11880
|
+
path: "/devops/v1/projects/{project}/test-reports",
|
|
11881
|
+
streaming: "no",
|
|
11882
|
+
pagination: false,
|
|
11883
|
+
pathParams: [
|
|
11884
|
+
{
|
|
11885
|
+
name: "project",
|
|
11886
|
+
sdkName: "project",
|
|
11887
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
11888
|
+
}
|
|
11889
|
+
],
|
|
11890
|
+
query: [],
|
|
11891
|
+
body: {
|
|
11892
|
+
required: true,
|
|
11893
|
+
fields: [
|
|
11894
|
+
{
|
|
11895
|
+
name: "reportId",
|
|
11896
|
+
type: "string",
|
|
11897
|
+
required: true,
|
|
11898
|
+
description: "Your own identifier for this report. Uploading the same id again is idempotent and counts once, so a retry after a timeout is safe."
|
|
11899
|
+
},
|
|
11900
|
+
{
|
|
11901
|
+
name: "format",
|
|
11902
|
+
type: "string",
|
|
11903
|
+
enum: [
|
|
11904
|
+
"ctrf",
|
|
11905
|
+
"junit"
|
|
11906
|
+
],
|
|
11907
|
+
required: true,
|
|
11908
|
+
description: "Which report format the document is in; it decides how the document is parsed."
|
|
11909
|
+
},
|
|
11910
|
+
{
|
|
11911
|
+
name: "ref",
|
|
11912
|
+
type: "object",
|
|
11913
|
+
required: true,
|
|
11914
|
+
description: "The exact revision a run tested. A commit is always named, because a run without one has nothing to report against."
|
|
11915
|
+
},
|
|
11916
|
+
{
|
|
11917
|
+
name: "report",
|
|
11918
|
+
type: "string",
|
|
11919
|
+
required: true,
|
|
11920
|
+
description: "The report document itself, as text — JSON for ctrf, XML for junit. Send the file's contents unchanged; a malformed document is refused with REPORT_INVALID and records nothing."
|
|
11921
|
+
}
|
|
11922
|
+
]
|
|
11923
|
+
}
|
|
11924
|
+
},
|
|
11925
|
+
{
|
|
11926
|
+
resource: "devops.projects.testRuns",
|
|
11927
|
+
method: "list",
|
|
11928
|
+
summary: "List test runs",
|
|
11929
|
+
description: "List the project's runs newest first, with each run's state, result and counts. Use it to find the run id whose executions you want to read, or to see whether a commit's tests have finished. A run whose result is pending has not reached a verdict yet — read it again rather than treating it as passed. Filter by state or result to watch only the runs still in flight.",
|
|
11930
|
+
http: "GET",
|
|
11931
|
+
path: "/devops/v1/projects/{project}/test-runs",
|
|
11932
|
+
streaming: "no",
|
|
11933
|
+
pagination: false,
|
|
11934
|
+
pathParams: [
|
|
11935
|
+
{
|
|
11936
|
+
name: "project",
|
|
11937
|
+
sdkName: "project",
|
|
11938
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
11939
|
+
}
|
|
11940
|
+
],
|
|
11941
|
+
query: [
|
|
11942
|
+
{
|
|
11943
|
+
name: "pageSize",
|
|
11944
|
+
type: "integer",
|
|
11945
|
+
required: false,
|
|
11946
|
+
description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone."
|
|
11947
|
+
},
|
|
11948
|
+
{
|
|
11949
|
+
name: "pageToken",
|
|
11950
|
+
type: "string",
|
|
11951
|
+
required: false,
|
|
11952
|
+
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
11953
|
+
},
|
|
11954
|
+
{
|
|
11955
|
+
name: "filter",
|
|
11956
|
+
type: "string",
|
|
11957
|
+
required: false,
|
|
11958
|
+
description: "AIP-160 equality filter over one declared field, for example state=running or result=failed. An undeclared field is refused with INVALID_ARGUMENT; it is never ignored, so a mistyped filter cannot quietly return everything."
|
|
11959
|
+
},
|
|
11960
|
+
{
|
|
11961
|
+
name: "orderBy",
|
|
11962
|
+
type: "string",
|
|
11963
|
+
required: false,
|
|
11964
|
+
description: "Comma-separated fields to order by, each optionally suffixed with desc, for example createTime desc. Only the fields the resource declares are accepted; anything else is refused so an ordering typo cannot silently return a different order. Omitted uses the resource's own order."
|
|
11965
|
+
}
|
|
11966
|
+
]
|
|
11967
|
+
},
|
|
11968
|
+
{
|
|
11969
|
+
resource: "devops.projects.testRuns",
|
|
11970
|
+
method: "create",
|
|
11971
|
+
summary: "Create a test run",
|
|
11972
|
+
description: "Start a run of the project's tests at one commit. Name a plan to use its selector, or pass a selector directly for this run alone; the ref says which commit to test and is required, because a run without a commit has nothing to report against. waitUntil decides how far the call waits before answering — queued returns as soon as the run exists, finished waits for a verdict and may take minutes. A retry of an earlier run is a new run: pass its commit and selector, and read the earlier run to compare.",
|
|
11973
|
+
http: "POST",
|
|
11974
|
+
path: "/devops/v1/projects/{project}/test-runs",
|
|
11975
|
+
streaming: "no",
|
|
11976
|
+
pagination: false,
|
|
11977
|
+
pathParams: [
|
|
11978
|
+
{
|
|
11979
|
+
name: "project",
|
|
11980
|
+
sdkName: "project",
|
|
11981
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
11982
|
+
}
|
|
11983
|
+
],
|
|
11984
|
+
query: [],
|
|
11985
|
+
body: {
|
|
11986
|
+
required: true,
|
|
11987
|
+
fields: [
|
|
11988
|
+
{
|
|
11989
|
+
name: "ref",
|
|
11990
|
+
type: "object",
|
|
11991
|
+
required: true,
|
|
11992
|
+
description: "The exact revision a run tested. A commit is always named, because a run without one has nothing to report against."
|
|
11993
|
+
},
|
|
11994
|
+
{
|
|
11995
|
+
name: "plan",
|
|
11996
|
+
type: "string",
|
|
11997
|
+
required: false,
|
|
11998
|
+
description: "Plan whose selector this run uses; omit it when passing selector instead. Naming a plan records the run against that plan, which is what a gate reads."
|
|
11999
|
+
},
|
|
12000
|
+
{
|
|
12001
|
+
name: "selector",
|
|
12002
|
+
type: "object",
|
|
12003
|
+
required: false,
|
|
12004
|
+
description: "An ad-hoc selector for this run alone, used instead of a plan's; it is not saved as a plan, so a run you want to repeat should name a plan."
|
|
12005
|
+
},
|
|
12006
|
+
{
|
|
12007
|
+
name: "environment",
|
|
12008
|
+
type: "string",
|
|
12009
|
+
required: false,
|
|
12010
|
+
description: "Environment to run against; it decides whether production-only cases become selectable. Omit it for a run that needs no environment."
|
|
12011
|
+
},
|
|
12012
|
+
{
|
|
12013
|
+
name: "repeat",
|
|
12014
|
+
type: "integer",
|
|
12015
|
+
required: false,
|
|
12016
|
+
description: "How many times each selected case runs, which is how a flake is told apart from a real failure; omit for once."
|
|
12017
|
+
},
|
|
12018
|
+
{
|
|
12019
|
+
name: "waitUntil",
|
|
12020
|
+
type: "string",
|
|
12021
|
+
enum: [
|
|
12022
|
+
"queued",
|
|
12023
|
+
"started",
|
|
12024
|
+
"finished"
|
|
12025
|
+
],
|
|
12026
|
+
required: false,
|
|
12027
|
+
description: "How far the call waits before answering — queued returns at once, started waits for execution to begin, finished waits for a verdict and may take minutes."
|
|
12028
|
+
}
|
|
12029
|
+
]
|
|
12030
|
+
}
|
|
12031
|
+
},
|
|
12032
|
+
{
|
|
12033
|
+
resource: "devops.projects.testSuites",
|
|
12034
|
+
method: "list",
|
|
12035
|
+
summary: "List test suites",
|
|
12036
|
+
description: "List the suites the project's newest catalog discovered — one suite per test file and framework pair, with its size, purposes and question count. Use it to find the suite id a case belongs to, or to see which files make up an area before selecting cases from them. Suites come from the catalog, so a file added in code appears only after its commit's catalog is published. Archived suites are returned too; they carry archived true and no case is ever silently dropped from the list.",
|
|
12037
|
+
http: "GET",
|
|
12038
|
+
path: "/devops/v1/projects/{project}/test-suites",
|
|
12039
|
+
streaming: "no",
|
|
12040
|
+
pagination: false,
|
|
12041
|
+
pathParams: [
|
|
12042
|
+
{
|
|
12043
|
+
name: "project",
|
|
12044
|
+
sdkName: "project",
|
|
12045
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
12046
|
+
}
|
|
12047
|
+
],
|
|
12048
|
+
query: [
|
|
12049
|
+
{
|
|
12050
|
+
name: "pageSize",
|
|
12051
|
+
type: "integer",
|
|
12052
|
+
required: false,
|
|
12053
|
+
description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone."
|
|
12054
|
+
},
|
|
12055
|
+
{
|
|
12056
|
+
name: "pageToken",
|
|
12057
|
+
type: "string",
|
|
12058
|
+
required: false,
|
|
12059
|
+
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
12060
|
+
},
|
|
12061
|
+
{
|
|
12062
|
+
name: "orderBy",
|
|
12063
|
+
type: "string",
|
|
12064
|
+
required: false,
|
|
12065
|
+
description: "Comma-separated fields to order by, each optionally suffixed with desc, for example createTime desc. Only the fields the resource declares are accepted; anything else is refused so an ordering typo cannot silently return a different order. Omitted uses the resource's own order."
|
|
12066
|
+
}
|
|
12067
|
+
]
|
|
12068
|
+
},
|
|
12069
|
+
{
|
|
12070
|
+
resource: "devops.testCases",
|
|
12071
|
+
method: "retrieve",
|
|
12072
|
+
summary: "Retrieve a test case",
|
|
12073
|
+
description: "Read one case in full — its steps, tags, declared owners, current state with the policy and ticket behind it, and its rolling 7 or 30 day statistics. Use it before quarantining or fixing a case, to see what the state already is and why. A case that was renamed is reachable by both its current fingerprint id and the ids listed in aliases.",
|
|
12074
|
+
http: "GET",
|
|
12075
|
+
path: "/devops/v1/test-cases/{id}",
|
|
12076
|
+
streaming: "no",
|
|
12077
|
+
pagination: false,
|
|
12078
|
+
pathParams: [
|
|
12079
|
+
{
|
|
12080
|
+
name: "id",
|
|
12081
|
+
sdkName: "id",
|
|
12082
|
+
description: "The case identifier returned by a case list, or an older id listed in that case's aliases."
|
|
12083
|
+
}
|
|
12084
|
+
],
|
|
12085
|
+
query: []
|
|
12086
|
+
},
|
|
12087
|
+
{
|
|
12088
|
+
resource: "devops.testPlans",
|
|
12089
|
+
method: "delete",
|
|
12090
|
+
summary: "Delete a test plan",
|
|
12091
|
+
description: "Delete a plan so it schedules nothing further. The plan stops firing immediately; runs it already produced keep their own record and are not deleted with it. To stop a plan temporarily and keep it for later, pause it instead — deleting cannot be undone and the plan's key becomes free for another plan to take.",
|
|
12092
|
+
http: "DELETE",
|
|
12093
|
+
path: "/devops/v1/test-plans/{id}",
|
|
12094
|
+
streaming: "no",
|
|
12095
|
+
pagination: false,
|
|
12096
|
+
pathParams: [
|
|
12097
|
+
{
|
|
12098
|
+
name: "id",
|
|
12099
|
+
sdkName: "id",
|
|
12100
|
+
description: "The plan identifier returned by a plan list or create answer."
|
|
12101
|
+
}
|
|
12102
|
+
],
|
|
12103
|
+
query: []
|
|
12104
|
+
},
|
|
12105
|
+
{
|
|
12106
|
+
resource: "devops.testPlans",
|
|
12107
|
+
method: "retrieve",
|
|
12108
|
+
summary: "Retrieve a test plan",
|
|
12109
|
+
description: "Read one plan by the id a plan list returned, to see its selector, gate, repeat count, timeout and pause state before updating or deleting it. A paused plan carries the reason, the actor and the time it resumes, so a pause you did not set is explained here rather than guessed at.",
|
|
12110
|
+
http: "GET",
|
|
12111
|
+
path: "/devops/v1/test-plans/{id}",
|
|
12112
|
+
streaming: "no",
|
|
12113
|
+
pagination: false,
|
|
12114
|
+
pathParams: [
|
|
12115
|
+
{
|
|
12116
|
+
name: "id",
|
|
12117
|
+
sdkName: "id",
|
|
12118
|
+
description: "The plan identifier returned by a plan list or create answer."
|
|
12119
|
+
}
|
|
12120
|
+
],
|
|
12121
|
+
query: []
|
|
12122
|
+
},
|
|
12123
|
+
{
|
|
12124
|
+
resource: "devops.testPlans",
|
|
12125
|
+
method: "update",
|
|
12126
|
+
summary: "Update a test plan",
|
|
12127
|
+
description: "Change a plan's title, trigger, selector, gate, repeat count, timeout or enabled flag. Only the fields present in the body are changed, so a body naming one field leaves the rest exactly as they were. Changing a selector does not create a version — the plan is not a published artefact, and runs already started keep the selection they were created with. Read the plan first to know what you are leaving unchanged.",
|
|
12128
|
+
http: "PATCH",
|
|
12129
|
+
path: "/devops/v1/test-plans/{id}",
|
|
12130
|
+
streaming: "no",
|
|
12131
|
+
pagination: false,
|
|
12132
|
+
pathParams: [
|
|
12133
|
+
{
|
|
12134
|
+
name: "id",
|
|
12135
|
+
sdkName: "id",
|
|
12136
|
+
description: "The plan identifier returned by a plan list or create answer."
|
|
12137
|
+
}
|
|
12138
|
+
],
|
|
12139
|
+
query: [],
|
|
12140
|
+
body: {
|
|
12141
|
+
required: true,
|
|
12142
|
+
fields: [
|
|
12143
|
+
{
|
|
12144
|
+
name: "plan",
|
|
12145
|
+
type: "object",
|
|
12146
|
+
required: true,
|
|
12147
|
+
description: "The fields to change. Anything absent keeps its current value, so read the plan first if you need to know what you are leaving alone."
|
|
12148
|
+
},
|
|
12149
|
+
{
|
|
12150
|
+
name: "updateMask",
|
|
12151
|
+
type: "string",
|
|
12152
|
+
required: false,
|
|
12153
|
+
description: "Comma-separated names of the plan fields this patch intends to change, for example title,enabled. Omit it to apply every field present in plan; naming fields makes the intent explicit and keeps a concurrent edit from being overwritten by accident."
|
|
12154
|
+
}
|
|
12155
|
+
]
|
|
12156
|
+
}
|
|
12157
|
+
},
|
|
12158
|
+
{
|
|
12159
|
+
resource: "devops.testPlans",
|
|
12160
|
+
method: "pause",
|
|
12161
|
+
summary: "Pause a test plan",
|
|
12162
|
+
description: "Stop a plan from starting new runs while keeping it and its history. A reason is required and is recorded on the plan, so the next reader learns why it stopped. Give until to resume automatically at a time; omit it to stay paused until someone resumes it. Runs already in flight are not cancelled — cancel those individually.",
|
|
12163
|
+
http: "POST",
|
|
12164
|
+
path: "/devops/v1/test-plans/{id}:pause",
|
|
12165
|
+
streaming: "no",
|
|
12166
|
+
pagination: false,
|
|
12167
|
+
pathParams: [
|
|
12168
|
+
{
|
|
12169
|
+
name: "id",
|
|
12170
|
+
sdkName: "id",
|
|
12171
|
+
description: "The plan identifier returned by a plan list or create answer."
|
|
12172
|
+
}
|
|
12173
|
+
],
|
|
12174
|
+
query: [],
|
|
12175
|
+
body: {
|
|
12176
|
+
required: true,
|
|
12177
|
+
fields: [
|
|
12178
|
+
{
|
|
12179
|
+
name: "reason",
|
|
12180
|
+
type: "string",
|
|
12181
|
+
required: true,
|
|
12182
|
+
description: "Why the plan is being paused; it is stored on the plan and read by whoever finds it stopped."
|
|
12183
|
+
},
|
|
12184
|
+
{
|
|
12185
|
+
name: "until",
|
|
12186
|
+
type: "string",
|
|
12187
|
+
required: false,
|
|
12188
|
+
description: "RFC 3339 UTC time the plan resumes by itself; omit it to stay paused until someone resumes it."
|
|
12189
|
+
}
|
|
12190
|
+
]
|
|
12191
|
+
}
|
|
12192
|
+
},
|
|
12193
|
+
{
|
|
12194
|
+
resource: "devops.testPlans",
|
|
12195
|
+
method: "resume",
|
|
12196
|
+
summary: "Resume a test plan",
|
|
12197
|
+
description: "Clear a plan's pause so it schedules runs again. Resuming an active plan changes nothing and is safe to repeat. The plan keeps its selector, gate and key; only the pause is removed.",
|
|
12198
|
+
http: "POST",
|
|
12199
|
+
path: "/devops/v1/test-plans/{id}:resume",
|
|
12200
|
+
streaming: "no",
|
|
12201
|
+
pagination: false,
|
|
12202
|
+
pathParams: [
|
|
12203
|
+
{
|
|
12204
|
+
name: "id",
|
|
12205
|
+
sdkName: "id",
|
|
12206
|
+
description: "The plan identifier returned by a plan list or create answer."
|
|
12207
|
+
}
|
|
12208
|
+
],
|
|
12209
|
+
query: []
|
|
12210
|
+
},
|
|
12211
|
+
{
|
|
12212
|
+
resource: "devops.testRuns",
|
|
12213
|
+
method: "retrieve",
|
|
12214
|
+
summary: "Retrieve a test run",
|
|
12215
|
+
description: "Read one run's current state, result and counts, and ask for its failed executions inline with expand. Poll this after creating a run whose result was pending. A result is monotonic once it reaches a verdict — a failed run never becomes passed by a later report, so read the run rather than the last report to know where it ended.",
|
|
12216
|
+
http: "GET",
|
|
12217
|
+
path: "/devops/v1/test-runs/{id}",
|
|
12218
|
+
streaming: "no",
|
|
12219
|
+
pagination: false,
|
|
12220
|
+
pathParams: [
|
|
12221
|
+
{
|
|
12222
|
+
name: "id",
|
|
12223
|
+
sdkName: "id",
|
|
12224
|
+
description: "The run identifier returned by a run list or create answer."
|
|
12225
|
+
}
|
|
12226
|
+
],
|
|
12227
|
+
query: [
|
|
12228
|
+
{
|
|
12229
|
+
name: "expand",
|
|
12230
|
+
type: "array",
|
|
12231
|
+
itemType: "string",
|
|
12232
|
+
enum: [
|
|
12233
|
+
"failedExecutions"
|
|
12234
|
+
],
|
|
12235
|
+
required: false,
|
|
12236
|
+
description: "Repeatable field to expand inline. failedExecutions returns the non-passed executions with the run, which saves a second call when you only need to see what broke; omit it for the bare run."
|
|
12237
|
+
}
|
|
12238
|
+
]
|
|
12239
|
+
},
|
|
12240
|
+
{
|
|
12241
|
+
resource: "devops.testRuns",
|
|
12242
|
+
method: "cancel",
|
|
12243
|
+
summary: "Cancel a test run",
|
|
12244
|
+
description: "Stop a run that is still going. A reason is required and is recorded on the run, because a cancelled run is read later as evidence about why a commit was not verified. Cancelling a run that already reached a verdict is refused with RUN_ALREADY_FINISHED: its result is final and cancelling it would erase the verdict. Executions already recorded stay readable.",
|
|
12245
|
+
http: "POST",
|
|
12246
|
+
path: "/devops/v1/test-runs/{id}:cancel",
|
|
12247
|
+
streaming: "no",
|
|
12248
|
+
pagination: false,
|
|
12249
|
+
pathParams: [
|
|
12250
|
+
{
|
|
12251
|
+
name: "id",
|
|
12252
|
+
sdkName: "id",
|
|
12253
|
+
description: "The run identifier returned by a run list or create answer."
|
|
12254
|
+
}
|
|
12255
|
+
],
|
|
12256
|
+
query: [],
|
|
12257
|
+
body: {
|
|
12258
|
+
required: true,
|
|
12259
|
+
fields: [
|
|
12260
|
+
{
|
|
12261
|
+
name: "reason",
|
|
12262
|
+
type: "string",
|
|
12263
|
+
required: true,
|
|
12264
|
+
description: "Why the run is being cancelled; it is stored on the run and is what a later reader finds instead of a result."
|
|
12265
|
+
}
|
|
12266
|
+
]
|
|
12267
|
+
}
|
|
12268
|
+
},
|
|
12269
|
+
{
|
|
12270
|
+
resource: "devops.testRuns.executions",
|
|
12271
|
+
method: "list",
|
|
12272
|
+
summary: "List a run's executions",
|
|
12273
|
+
description: "List the executions recorded against one run — one entry per case the run selected, with its status, duration, attempts and evidence. Use it to find the case that failed, or to compare a repeat run against the previous one case by case. Reads happen while the run is still going, so a case may still be pending; filter by status to watch only the failures.",
|
|
12274
|
+
http: "GET",
|
|
12275
|
+
path: "/devops/v1/test-runs/{run}/executions",
|
|
12276
|
+
streaming: "no",
|
|
12277
|
+
pagination: false,
|
|
12278
|
+
pathParams: [
|
|
12279
|
+
{
|
|
12280
|
+
name: "run",
|
|
12281
|
+
sdkName: "run",
|
|
12282
|
+
description: "The run whose executions you are reading, from a run list or create answer."
|
|
12283
|
+
}
|
|
12284
|
+
],
|
|
12285
|
+
query: [
|
|
12286
|
+
{
|
|
12287
|
+
name: "pageSize",
|
|
12288
|
+
type: "integer",
|
|
12289
|
+
required: false,
|
|
12290
|
+
description: "How many items this page returns, 1 to 100; omitted uses 50. A larger value is capped at 100 rather than refused, and 0 falls back to the default, so a paging loop never fails on a size alone."
|
|
12291
|
+
},
|
|
12292
|
+
{
|
|
12293
|
+
name: "pageToken",
|
|
12294
|
+
type: "string",
|
|
12295
|
+
required: false,
|
|
12296
|
+
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
12297
|
+
},
|
|
12298
|
+
{
|
|
12299
|
+
name: "orderBy",
|
|
12300
|
+
type: "string",
|
|
12301
|
+
required: false,
|
|
12302
|
+
description: "Comma-separated fields to order by, each optionally suffixed with desc, for example createTime desc. Only the fields the resource declares are accepted; anything else is refused so an ordering typo cannot silently return a different order. Omitted uses the resource's own order."
|
|
12303
|
+
}
|
|
12304
|
+
]
|
|
12305
|
+
},
|
|
12306
|
+
{
|
|
12307
|
+
resource: "devops.testRuns.executions",
|
|
12308
|
+
method: "retrieve",
|
|
12309
|
+
summary: "Retrieve one case's execution in a run",
|
|
12310
|
+
description: "Read one case's execution inside one run, including every attempt with its own duration and message. Use it after a run reports a failure to see whether the case failed once and passed on retry — that is what flaky true means — and to reach the evidence files a triage needs. Both ids come from the run and case reads; an execution that does not exist for that pair is NOT_FOUND rather than an empty answer.",
|
|
12311
|
+
http: "GET",
|
|
12312
|
+
path: "/devops/v1/test-runs/{run}/executions/{case}",
|
|
12313
|
+
streaming: "no",
|
|
12314
|
+
pagination: false,
|
|
12315
|
+
pathParams: [
|
|
12316
|
+
{
|
|
12317
|
+
name: "run",
|
|
12318
|
+
sdkName: "run",
|
|
12319
|
+
description: "The run whose executions you are reading, from a run list or create answer."
|
|
12320
|
+
},
|
|
12321
|
+
{
|
|
12322
|
+
name: "case",
|
|
12323
|
+
sdkName: "case",
|
|
12324
|
+
description: "The case to read inside that run, from the run's execution list or the project's case list."
|
|
12325
|
+
}
|
|
12326
|
+
],
|
|
12327
|
+
query: []
|
|
12328
|
+
},
|
|
12329
|
+
{
|
|
12330
|
+
resource: "devops.testSuites",
|
|
12331
|
+
method: "retrieve",
|
|
12332
|
+
summary: "Retrieve a test suite",
|
|
12333
|
+
description: "Read one suite by the id a suite list returned, to learn its file, framework, size, purposes and how many cases it holds. Use it when a case's suite id needs a name for display, or to confirm which commit's catalog a suite came from. The id is opaque; it comes from the list, never from the file path.",
|
|
12334
|
+
http: "GET",
|
|
12335
|
+
path: "/devops/v1/test-suites/{id}",
|
|
12336
|
+
streaming: "no",
|
|
12337
|
+
pagination: false,
|
|
12338
|
+
pathParams: [
|
|
12339
|
+
{
|
|
12340
|
+
name: "id",
|
|
12341
|
+
sdkName: "id",
|
|
12342
|
+
description: "The suite identifier returned by a suite list, not the file path it was discovered from."
|
|
12343
|
+
}
|
|
12344
|
+
],
|
|
12345
|
+
query: []
|
|
12346
|
+
},
|
|
11422
12347
|
{
|
|
11423
12348
|
resource: "file.files",
|
|
11424
12349
|
method: "list",
|
|
@@ -11630,7 +12555,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11630
12555
|
resource: "file.uploads",
|
|
11631
12556
|
method: "create",
|
|
11632
12557
|
summary: "Create an upload",
|
|
11633
|
-
description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most
|
|
12558
|
+
description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 20 GiB (21474836480 bytes) and only user_data, assistants and vision purposes. Send parts of at most 64000000 bytes; an unfinished upload waits for them for 7 days, so a client can create → send parts → query GET /file/v1/uploads/{upload_id} → resend only the missing parts → complete. Optional part_size fixes every part length and makes each numbered part retryable with identical bytes. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
|
|
11634
12559
|
http: "POST",
|
|
11635
12560
|
path: "/file/v1/uploads",
|
|
11636
12561
|
streaming: "no",
|
|
@@ -11644,7 +12569,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11644
12569
|
name: "bytes",
|
|
11645
12570
|
type: "integer",
|
|
11646
12571
|
required: true,
|
|
11647
|
-
description: "Exact complete file length in bytes, from 1 through
|
|
12572
|
+
description: "Exact complete file length in bytes, from 1 through 21474836480 (20 GiB); the sum of completed parts must match."
|
|
11648
12573
|
},
|
|
11649
12574
|
{
|
|
11650
12575
|
name: "filename",
|
|
@@ -11688,7 +12613,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11688
12613
|
resource: "file.uploads",
|
|
11689
12614
|
method: "createSigned",
|
|
11690
12615
|
summary: "Create a one-time upload URL",
|
|
11691
|
-
description: "Upload a local file of up to
|
|
12616
|
+
description: "Upload a local file of up to 20 GiB from a coding agent without sending bytes through the model. Provide basename, exact byte count and MIME type. Up to 104857600 bytes, PUT the file to url with curl -T photo.png -H 'Content-Type: image/png' '<url>'; success returns 201 with the file object, and reuse returns 410 CAPABILITY_USED. Above that threshold, split the file into part_size chunks (default 64000000 bytes) and PUT each chunk to its numbered parts[].url in any order; an interrupted client GETs status_url to see the received parts and resends only what is missing, then POSTs complete_url without a body. Part PUTs return 200; completion returns 201 with the file object, including its state, or 400 if a part is missing. A processing file can be polled with files.retrieve until active. Identical part bytes may be retried; changed bytes at the same number return 400. Completion reuse returns 410 CAPABILITY_USED. Each PUT requires the exact signed Content-Length; single-PUT Content-Type must match content_type or be omitted. Expired, revoked, invalid, wrong-action or cross-organization URLs return 404. URL lifetime defaults to 900 seconds for single PUT or 604800 (7 days) for multipart, at most 604800; all multipart URLs, including status_url, share an expiry. Multipart creation reserves storage quota. Issuance requires the same unscoped credential as direct file creation. Each issuance creates a new upload and is not idempotent. Example body: {\"filename\":\"photo.png\",\"bytes\":2048,\"content_type\":\"image/png\"}.",
|
|
11692
12617
|
http: "POST",
|
|
11693
12618
|
path: "/file/v1/uploads/signed",
|
|
11694
12619
|
streaming: "no",
|
|
@@ -11708,7 +12633,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11708
12633
|
name: "bytes",
|
|
11709
12634
|
type: "integer",
|
|
11710
12635
|
required: true,
|
|
11711
|
-
description: "Exact local file size in bytes, from 1 through
|
|
12636
|
+
description: "Exact local file size in bytes, from 1 through 21474836480 (20 GiB). Up to 104857600 bytes returns one PUT URL; larger files return numbered part URLs, a completion URL and a status URL. Every PUT requires its exact signed Content-Length."
|
|
11712
12637
|
},
|
|
11713
12638
|
{
|
|
11714
12639
|
name: "content_type",
|
|
@@ -11731,7 +12656,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11731
12656
|
name: "expires_in",
|
|
11732
12657
|
type: "integer",
|
|
11733
12658
|
required: false,
|
|
11734
|
-
description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or
|
|
12659
|
+
description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or 604800 (7 days) for multipart. All part URLs, the status URL and the completion URL share one expiry. This does not set the resulting file's lifetime."
|
|
11735
12660
|
},
|
|
11736
12661
|
{
|
|
11737
12662
|
name: "part_size",
|
|
@@ -11742,6 +12667,24 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11742
12667
|
]
|
|
11743
12668
|
}
|
|
11744
12669
|
},
|
|
12670
|
+
{
|
|
12671
|
+
resource: "file.uploads",
|
|
12672
|
+
method: "retrieve",
|
|
12673
|
+
summary: "Retrieve an upload",
|
|
12674
|
+
description: "Read the state of an unfinished upload — its status, declared bytes, fixed part_size and the parts it already holds (received_parts, each with part_number, bytes and sha256). After a break or a failed part, call it to resend only the missing numbers, then complete. A cancelled or expired upload is refused; a completed one returns its file. A missing or other-organization upload returns 404.",
|
|
12675
|
+
http: "GET",
|
|
12676
|
+
path: "/file/v1/uploads/{upload_id}",
|
|
12677
|
+
streaming: "no",
|
|
12678
|
+
pagination: false,
|
|
12679
|
+
pathParams: [
|
|
12680
|
+
{
|
|
12681
|
+
name: "upload_id",
|
|
12682
|
+
sdkName: "upload_id",
|
|
12683
|
+
description: "Upload identifier returned by create; the upload must belong to your organization."
|
|
12684
|
+
}
|
|
12685
|
+
],
|
|
12686
|
+
query: []
|
|
12687
|
+
},
|
|
11745
12688
|
{
|
|
11746
12689
|
resource: "file.uploads",
|
|
11747
12690
|
method: "cancel",
|
|
@@ -11764,7 +12707,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11764
12707
|
resource: "file.uploads",
|
|
11765
12708
|
method: "complete",
|
|
11766
12709
|
summary: "Complete an upload",
|
|
11767
|
-
description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.",
|
|
12710
|
+
description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. When parts were lost, query GET /file/v1/uploads/{upload_id} and resend them before completing. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.",
|
|
11768
12711
|
http: "POST",
|
|
11769
12712
|
path: "/file/v1/uploads/{upload_id}/complete",
|
|
11770
12713
|
streaming: "no",
|
|
@@ -11800,7 +12743,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11800
12743
|
resource: "file.uploads.parts",
|
|
11801
12744
|
method: "create",
|
|
11802
12745
|
summary: "Add an upload part",
|
|
11803
|
-
description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.",
|
|
12746
|
+
description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID, and query GET /file/v1/uploads/{upload_id} to see which numbers already arrived. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.",
|
|
11804
12747
|
http: "POST",
|
|
11805
12748
|
path: "/file/v1/uploads/{upload_id}/parts",
|
|
11806
12749
|
streaming: "no",
|
|
@@ -12613,6 +13556,18 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12613
13556
|
],
|
|
12614
13557
|
query: []
|
|
12615
13558
|
},
|
|
13559
|
+
{
|
|
13560
|
+
resource: "media.generation.capabilities",
|
|
13561
|
+
method: "list",
|
|
13562
|
+
summary: "Get generation capabilities",
|
|
13563
|
+
description: "Read supported text-to-video intent, default model, duration and aspect-ratio limits, per-library concurrency and candidate retention. Generation is charged per second; unsaved candidates expire after 7 days.",
|
|
13564
|
+
http: "GET",
|
|
13565
|
+
path: "/media/v1/generation/capabilities",
|
|
13566
|
+
streaming: "no",
|
|
13567
|
+
pagination: false,
|
|
13568
|
+
pathParams: [],
|
|
13569
|
+
query: []
|
|
13570
|
+
},
|
|
12616
13571
|
{
|
|
12617
13572
|
resource: "media.libraries",
|
|
12618
13573
|
method: "list",
|
|
@@ -12837,7 +13792,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12837
13792
|
resource: "media.libraries.assets",
|
|
12838
13793
|
method: "create",
|
|
12839
13794
|
summary: "Upload asset",
|
|
12840
|
-
description: " For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
13795
|
+
description: " For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.",
|
|
12841
13796
|
http: "POST",
|
|
12842
13797
|
path: "/media/v1/libraries/{library_id}/assets",
|
|
12843
13798
|
streaming: "no",
|
|
@@ -12961,7 +13916,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12961
13916
|
resource: "media.libraries.assets.import",
|
|
12962
13917
|
method: "create",
|
|
12963
13918
|
summary: "Import file",
|
|
12964
|
-
description: "Copy a File into an independent Media asset. New assets default to organization-private delivery (type=authenticated); explicitly set type=upload for public originals and derivatives. Omitting type on overwrite preserves the current type. Deleting the source File does not delete this copy. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
13919
|
+
description: "Copy a File into an independent Media asset. New assets default to organization-private delivery (type=authenticated); explicitly set type=upload for public originals and derivatives. Omitting type on overwrite preserves the current type. Deleting the source File does not delete this copy. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.",
|
|
12965
13920
|
http: "POST",
|
|
12966
13921
|
path: "/media/v1/libraries/{library_id}/assets/import",
|
|
12967
13922
|
streaming: "no",
|
|
@@ -13229,7 +14184,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13229
14184
|
resource: "media.libraries.assets.reprocess",
|
|
13230
14185
|
method: "create",
|
|
13231
14186
|
summary: "Reprocess asset",
|
|
13232
|
-
description: " For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
14187
|
+
description: " For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.",
|
|
13233
14188
|
http: "POST",
|
|
13234
14189
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess",
|
|
13235
14190
|
streaming: "no",
|
|
@@ -13305,10 +14260,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13305
14260
|
"frame",
|
|
13306
14261
|
"overview",
|
|
13307
14262
|
"audio",
|
|
14263
|
+
"loudness",
|
|
14264
|
+
"beats",
|
|
14265
|
+
"content",
|
|
13308
14266
|
"embedding"
|
|
13309
14267
|
],
|
|
13310
14268
|
required: false,
|
|
13311
|
-
description: "Return one output kind: caption is a visual description, tags are generated labels, ocr is visible text, transcript is speech, frame is a video shot, overview is a video summary, audio is sampled audio understanding, and embedding reports a failed embedding step."
|
|
14269
|
+
description: "Return one output kind: caption is a visual description, tags are generated labels, ocr is visible text, transcript is speech, frame is a video shot, overview is a video summary, audio is sampled audio understanding, loudness is measured loudness, beats is the measured tempo and beat grid, content is the derived speech, music and silence split, and embedding reports a failed embedding step."
|
|
13312
14270
|
},
|
|
13313
14271
|
{
|
|
13314
14272
|
name: "cursor",
|
|
@@ -13328,7 +14286,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13328
14286
|
resource: "media.libraries.assets",
|
|
13329
14287
|
method: "batch",
|
|
13330
14288
|
summary: "Batch assets alias",
|
|
13331
|
-
description: 'Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
14289
|
+
description: 'Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.',
|
|
13332
14290
|
http: "POST",
|
|
13333
14291
|
path: "/media/v1/libraries/{library_id}/assets:batch",
|
|
13334
14292
|
streaming: "no",
|
|
@@ -13363,7 +14321,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13363
14321
|
resource: "media.libraries.batches",
|
|
13364
14322
|
method: "create",
|
|
13365
14323
|
summary: "Create batch",
|
|
13366
|
-
description: 'Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged.
|
|
14324
|
+
description: 'Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {"action":"reprocess","selector":{"expression":"processing_state=failed AND failure_code=UPSTREAM_FAILED"}}. For understanding, Media generates proxies for video sources of 25 MB or more or longer than 10 minutes, and for audio-only sources of 100 MB or more; originals remain available unchanged. Long videos are supported. When a video proxy is needed and is still above 95 MB after recompression, the source is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.',
|
|
13367
14325
|
http: "POST",
|
|
13368
14326
|
path: "/media/v1/libraries/{library_id}/batches",
|
|
13369
14327
|
streaming: "no",
|
|
@@ -13524,11 +14482,155 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13524
14482
|
}
|
|
13525
14483
|
]
|
|
13526
14484
|
},
|
|
14485
|
+
{
|
|
14486
|
+
resource: "media.libraries.generations",
|
|
14487
|
+
method: "create",
|
|
14488
|
+
summary: "Create video generation",
|
|
14489
|
+
description: "Create a video.generate job. Generation is charged per second. The response is 202 with a queued Job; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until terminal, then save successful outputs. Unsaved candidate Files expire after 7 days.",
|
|
14490
|
+
http: "POST",
|
|
14491
|
+
path: "/media/v1/libraries/{library_id}/generations",
|
|
14492
|
+
streaming: "no",
|
|
14493
|
+
pagination: false,
|
|
14494
|
+
pathParams: [
|
|
14495
|
+
{
|
|
14496
|
+
name: "library_id",
|
|
14497
|
+
sdkName: "library_id",
|
|
14498
|
+
description: "Library ID returned by creation."
|
|
14499
|
+
}
|
|
14500
|
+
],
|
|
14501
|
+
query: [],
|
|
14502
|
+
body: {
|
|
14503
|
+
required: true,
|
|
14504
|
+
fields: [
|
|
14505
|
+
{
|
|
14506
|
+
name: "intent",
|
|
14507
|
+
type: "string",
|
|
14508
|
+
required: true,
|
|
14509
|
+
description: "Generation operation; v1 accepts only video.generate text-to-video requests."
|
|
14510
|
+
},
|
|
14511
|
+
{
|
|
14512
|
+
name: "prompt",
|
|
14513
|
+
type: "string",
|
|
14514
|
+
required: true,
|
|
14515
|
+
description: "Text prompt describing the video to generate."
|
|
14516
|
+
},
|
|
14517
|
+
{
|
|
14518
|
+
name: "count",
|
|
14519
|
+
type: "integer",
|
|
14520
|
+
required: false,
|
|
14521
|
+
description: "Number of videos to generate; defaults to 1 and must be from 1 to 4."
|
|
14522
|
+
},
|
|
14523
|
+
{
|
|
14524
|
+
name: "duration_seconds",
|
|
14525
|
+
type: "integer",
|
|
14526
|
+
required: false,
|
|
14527
|
+
description: "Requested video duration in seconds; Router validates the model-specific supported durations."
|
|
14528
|
+
},
|
|
14529
|
+
{
|
|
14530
|
+
name: "aspect_ratio",
|
|
14531
|
+
type: "string",
|
|
14532
|
+
required: false,
|
|
14533
|
+
description: "Requested output aspect ratio; defaults to 16:9 and Router validates model support."
|
|
14534
|
+
},
|
|
14535
|
+
{
|
|
14536
|
+
name: "model",
|
|
14537
|
+
type: "string",
|
|
14538
|
+
required: false,
|
|
14539
|
+
description: "Router model with video_generation capability; defaults to wan2.7-t2v."
|
|
14540
|
+
},
|
|
14541
|
+
{
|
|
14542
|
+
name: "save",
|
|
14543
|
+
type: "string",
|
|
14544
|
+
enum: [
|
|
14545
|
+
"candidate",
|
|
14546
|
+
"library"
|
|
14547
|
+
],
|
|
14548
|
+
required: false,
|
|
14549
|
+
description: "candidate keeps outputs temporary for explicit save calls; library saves successful outputs automatically."
|
|
14550
|
+
},
|
|
14551
|
+
{
|
|
14552
|
+
name: "asset_folder",
|
|
14553
|
+
type: "string",
|
|
14554
|
+
required: false,
|
|
14555
|
+
description: "Folder for assets saved automatically or by later save calls; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
14556
|
+
},
|
|
14557
|
+
{
|
|
14558
|
+
name: "tags",
|
|
14559
|
+
type: "array",
|
|
14560
|
+
itemType: "string",
|
|
14561
|
+
required: false,
|
|
14562
|
+
description: "Tags applied when an output becomes a library asset."
|
|
14563
|
+
},
|
|
14564
|
+
{
|
|
14565
|
+
name: "understanding",
|
|
14566
|
+
type: "string",
|
|
14567
|
+
enum: [
|
|
14568
|
+
"auto",
|
|
14569
|
+
"skip"
|
|
14570
|
+
],
|
|
14571
|
+
required: false,
|
|
14572
|
+
description: "Understanding behavior when a candidate is saved as an asset; defaults to auto."
|
|
14573
|
+
},
|
|
14574
|
+
{
|
|
14575
|
+
name: "references",
|
|
14576
|
+
type: "array",
|
|
14577
|
+
itemType: "object",
|
|
14578
|
+
required: false,
|
|
14579
|
+
description: "Not supported in v1; omit this field. Only text-to-video is currently available."
|
|
14580
|
+
}
|
|
14581
|
+
]
|
|
14582
|
+
}
|
|
14583
|
+
},
|
|
14584
|
+
{
|
|
14585
|
+
resource: "media.libraries.jobs",
|
|
14586
|
+
method: "list",
|
|
14587
|
+
summary: "List jobs",
|
|
14588
|
+
description: "List batch and video-generation jobs in a library. Filter by status and continue with next_cursor. Poll a generation Job until terminal, then save successful candidate outputs before they expire after 7 days.",
|
|
14589
|
+
http: "GET",
|
|
14590
|
+
path: "/media/v1/libraries/{library_id}/jobs",
|
|
14591
|
+
streaming: "no",
|
|
14592
|
+
pagination: true,
|
|
14593
|
+
pathParams: [
|
|
14594
|
+
{
|
|
14595
|
+
name: "library_id",
|
|
14596
|
+
sdkName: "library_id",
|
|
14597
|
+
description: "Library ID returned by creation."
|
|
14598
|
+
}
|
|
14599
|
+
],
|
|
14600
|
+
query: [
|
|
14601
|
+
{
|
|
14602
|
+
name: "status",
|
|
14603
|
+
type: "string",
|
|
14604
|
+
enum: [
|
|
14605
|
+
"queued",
|
|
14606
|
+
"running",
|
|
14607
|
+
"completed",
|
|
14608
|
+
"completed_with_errors",
|
|
14609
|
+
"failed",
|
|
14610
|
+
"cancelled"
|
|
14611
|
+
],
|
|
14612
|
+
required: false,
|
|
14613
|
+
description: "Filter jobs by their current status."
|
|
14614
|
+
},
|
|
14615
|
+
{
|
|
14616
|
+
name: "limit",
|
|
14617
|
+
type: "integer",
|
|
14618
|
+
required: false,
|
|
14619
|
+
description: "Maximum entries in this page, from 1 through 100; defaults to 100."
|
|
14620
|
+
},
|
|
14621
|
+
{
|
|
14622
|
+
name: "cursor",
|
|
14623
|
+
type: "string",
|
|
14624
|
+
required: false,
|
|
14625
|
+
description: "Job id from the previous page’s next_cursor; omit for the first page."
|
|
14626
|
+
}
|
|
14627
|
+
]
|
|
14628
|
+
},
|
|
13527
14629
|
{
|
|
13528
14630
|
resource: "media.libraries.jobs",
|
|
13529
14631
|
method: "retrieve",
|
|
13530
|
-
summary: "Get job
|
|
13531
|
-
description: "Read
|
|
14632
|
+
summary: "Get job",
|
|
14633
|
+
description: "Read the current batch or video-generation Job status and progress. For generation, inspect outputs and failures, then save successful candidates before their preview and save window expires after 7 days.",
|
|
13532
14634
|
http: "GET",
|
|
13533
14635
|
path: "/media/v1/libraries/{library_id}/jobs/{job_id}",
|
|
13534
14636
|
streaming: "no",
|
|
@@ -13542,11 +14644,96 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13542
14644
|
{
|
|
13543
14645
|
name: "job_id",
|
|
13544
14646
|
sdkName: "job_id",
|
|
13545
|
-
description: "
|
|
14647
|
+
description: "Job identifier returned by batch creation, video-generation creation or job listing; resolved within this library."
|
|
13546
14648
|
}
|
|
13547
14649
|
],
|
|
13548
14650
|
query: []
|
|
13549
14651
|
},
|
|
14652
|
+
{
|
|
14653
|
+
resource: "media.libraries.jobs",
|
|
14654
|
+
method: "cancel",
|
|
14655
|
+
summary: "Cancel job",
|
|
14656
|
+
description: "Cancel a queued or running generation job. Already completed outputs remain available to save; poll or read the returned Job to confirm its status.",
|
|
14657
|
+
http: "POST",
|
|
14658
|
+
path: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
|
|
14659
|
+
streaming: "no",
|
|
14660
|
+
pagination: false,
|
|
14661
|
+
pathParams: [
|
|
14662
|
+
{
|
|
14663
|
+
name: "library_id",
|
|
14664
|
+
sdkName: "library_id",
|
|
14665
|
+
description: "Library ID returned by creation."
|
|
14666
|
+
},
|
|
14667
|
+
{
|
|
14668
|
+
name: "job_id",
|
|
14669
|
+
sdkName: "job_id",
|
|
14670
|
+
description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
|
|
14671
|
+
}
|
|
14672
|
+
],
|
|
14673
|
+
query: []
|
|
14674
|
+
},
|
|
14675
|
+
{
|
|
14676
|
+
resource: "media.libraries.jobs.outputs.save",
|
|
14677
|
+
method: "create",
|
|
14678
|
+
summary: "Save generation output",
|
|
14679
|
+
description: "Save a successful candidate as a library asset. Candidate outputs expire after 7 days; save before expiry. Generation is charged per second when the job runs, not when an output is saved.",
|
|
14680
|
+
http: "POST",
|
|
14681
|
+
path: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
|
|
14682
|
+
streaming: "no",
|
|
14683
|
+
pagination: false,
|
|
14684
|
+
pathParams: [
|
|
14685
|
+
{
|
|
14686
|
+
name: "library_id",
|
|
14687
|
+
sdkName: "library_id",
|
|
14688
|
+
description: "Library ID returned by creation."
|
|
14689
|
+
},
|
|
14690
|
+
{
|
|
14691
|
+
name: "job_id",
|
|
14692
|
+
sdkName: "job_id",
|
|
14693
|
+
description: "Job identifier returned by batch or generation creation; the job is resolved within the specified library."
|
|
14694
|
+
},
|
|
14695
|
+
{
|
|
14696
|
+
name: "index",
|
|
14697
|
+
sdkName: "index",
|
|
14698
|
+
description: "Zero-based position of the candidate in the Job outputs array."
|
|
14699
|
+
}
|
|
14700
|
+
],
|
|
14701
|
+
query: [],
|
|
14702
|
+
body: {
|
|
14703
|
+
required: false,
|
|
14704
|
+
fields: [
|
|
14705
|
+
{
|
|
14706
|
+
name: "public_id",
|
|
14707
|
+
type: "string",
|
|
14708
|
+
required: false,
|
|
14709
|
+
description: "Delivery identifier for the saved asset; defaults to gen_<job_id>_<index> and is idempotent."
|
|
14710
|
+
},
|
|
14711
|
+
{
|
|
14712
|
+
name: "asset_folder",
|
|
14713
|
+
type: "string",
|
|
14714
|
+
required: false,
|
|
14715
|
+
description: "Destination folder for the saved asset; defaults to the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
14716
|
+
},
|
|
14717
|
+
{
|
|
14718
|
+
name: "tags",
|
|
14719
|
+
type: "array",
|
|
14720
|
+
itemType: "string",
|
|
14721
|
+
required: false,
|
|
14722
|
+
description: "Tags to apply to the saved asset."
|
|
14723
|
+
},
|
|
14724
|
+
{
|
|
14725
|
+
name: "understanding",
|
|
14726
|
+
type: "string",
|
|
14727
|
+
enum: [
|
|
14728
|
+
"auto",
|
|
14729
|
+
"skip"
|
|
14730
|
+
],
|
|
14731
|
+
required: false,
|
|
14732
|
+
description: "Understanding behavior for the saved asset; defaults to auto."
|
|
14733
|
+
}
|
|
14734
|
+
]
|
|
14735
|
+
}
|
|
14736
|
+
},
|
|
13550
14737
|
{
|
|
13551
14738
|
resource: "media.libraries.purge",
|
|
13552
14739
|
method: "create",
|
|
@@ -13831,7 +15018,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13831
15018
|
name: "kinds",
|
|
13832
15019
|
type: "string",
|
|
13833
15020
|
required: false,
|
|
13834
|
-
description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind."
|
|
15021
|
+
description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, loudness, beats, content, embedding. Omit or empty to include every kind."
|
|
13835
15022
|
},
|
|
13836
15023
|
{
|
|
13837
15024
|
name: "cursor",
|
|
@@ -16347,6 +17534,539 @@ for more details.`
|
|
|
16347
17534
|
],
|
|
16348
17535
|
query: []
|
|
16349
17536
|
},
|
|
17537
|
+
{
|
|
17538
|
+
resource: "ontology.changesets",
|
|
17539
|
+
method: "create",
|
|
17540
|
+
summary: "Apply changeset",
|
|
17541
|
+
description: "Apply a batch of node, relation and invalidation operations as one transaction, when a mirror has several records to write together and a partial write would leave the graph inconsistent. Every operation succeeds or none is applied. Send an Idempotency-Key header; the same key with the same content replays the first result, and the same key with different content is ONTOLOGY_CONFLICT.",
|
|
17542
|
+
http: "POST",
|
|
17543
|
+
path: "/ontology/v1/changesets",
|
|
17544
|
+
streaming: "no",
|
|
17545
|
+
pagination: false,
|
|
17546
|
+
pathParams: [],
|
|
17547
|
+
query: [],
|
|
17548
|
+
body: {
|
|
17549
|
+
required: true,
|
|
17550
|
+
fields: [
|
|
17551
|
+
{
|
|
17552
|
+
name: "at",
|
|
17553
|
+
type: "string",
|
|
17554
|
+
required: true,
|
|
17555
|
+
description: "World time the batch describes, in ISO 8601 UTC; operations without their own time are dated by it."
|
|
17556
|
+
},
|
|
17557
|
+
{
|
|
17558
|
+
name: "scope",
|
|
17559
|
+
type: "string",
|
|
17560
|
+
required: false,
|
|
17561
|
+
description: "Scope the batch came from, normally the session id it was observed in; it is stored with the operations for later reading."
|
|
17562
|
+
},
|
|
17563
|
+
{
|
|
17564
|
+
name: "ops",
|
|
17565
|
+
type: "array",
|
|
17566
|
+
itemType: "object",
|
|
17567
|
+
required: true,
|
|
17568
|
+
description: "At most 500 operations, applied in order; each names its kind in op and the fields that kind requires."
|
|
17569
|
+
}
|
|
17570
|
+
]
|
|
17571
|
+
}
|
|
17572
|
+
},
|
|
17573
|
+
{
|
|
17574
|
+
resource: "ontology.nodes",
|
|
17575
|
+
method: "list",
|
|
17576
|
+
summary: "List nodes",
|
|
17577
|
+
description: "Discover the entities in this organization's graph and obtain node ids for retrieval, updates and relations. Filter by type, by free text over names, aliases, descriptions and facts, or by owner; limit is 1–100 and defaults to 50. Omit cursor for the first page, then copy next_cursor into the next request until it is null. A node whose content belongs to somebody else comes back as a restricted entry carrying only its id, type and name.",
|
|
17578
|
+
http: "GET",
|
|
17579
|
+
path: "/ontology/v1/nodes",
|
|
17580
|
+
streaming: "no",
|
|
17581
|
+
pagination: true,
|
|
17582
|
+
pathParams: [],
|
|
17583
|
+
query: [
|
|
17584
|
+
{
|
|
17585
|
+
name: "type",
|
|
17586
|
+
type: "array",
|
|
17587
|
+
itemType: "string",
|
|
17588
|
+
required: false,
|
|
17589
|
+
description: "Repeat to filter to any of several registered node type names, for example type=file&type=ticket; omit to list every type."
|
|
17590
|
+
},
|
|
17591
|
+
{
|
|
17592
|
+
name: "q",
|
|
17593
|
+
type: "string",
|
|
17594
|
+
required: false,
|
|
17595
|
+
description: "Free text matched against node names, aliases and descriptions; omit to list without a text filter."
|
|
17596
|
+
},
|
|
17597
|
+
{
|
|
17598
|
+
name: "owner",
|
|
17599
|
+
type: "string",
|
|
17600
|
+
required: false,
|
|
17601
|
+
description: "Filter to nodes owned by this member id, or omit to list nodes of every owner; organization-wide nodes carry no owner."
|
|
17602
|
+
},
|
|
17603
|
+
{
|
|
17604
|
+
name: "as_of",
|
|
17605
|
+
type: "string",
|
|
17606
|
+
required: false,
|
|
17607
|
+
description: "ISO 8601 timestamp; return the graph as it was then, so a node recorded later is absent. Omit to read current state."
|
|
17608
|
+
},
|
|
17609
|
+
{
|
|
17610
|
+
name: "limit",
|
|
17611
|
+
type: "integer",
|
|
17612
|
+
required: false,
|
|
17613
|
+
description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100."
|
|
17614
|
+
},
|
|
17615
|
+
{
|
|
17616
|
+
name: "cursor",
|
|
17617
|
+
type: "string",
|
|
17618
|
+
required: false,
|
|
17619
|
+
description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
|
|
17620
|
+
}
|
|
17621
|
+
]
|
|
17622
|
+
},
|
|
17623
|
+
{
|
|
17624
|
+
resource: "ontology.nodes",
|
|
17625
|
+
method: "create",
|
|
17626
|
+
summary: "Create node",
|
|
17627
|
+
description: "Record one entity in the graph, for a system mirroring a record it owns. type must already be registered and ref, when given, must match that type's ref_prefix. Send an Idempotency-Key header; repeating the same key with the same content returns the first result instead of creating a second node. This writes structure only — to give an agent something to remember, use POST /agent/v1/agents/{agent_id}/consolidations.",
|
|
17628
|
+
http: "POST",
|
|
17629
|
+
path: "/ontology/v1/nodes",
|
|
17630
|
+
streaming: "no",
|
|
17631
|
+
pagination: false,
|
|
17632
|
+
pathParams: [],
|
|
17633
|
+
query: [],
|
|
17634
|
+
body: {
|
|
17635
|
+
required: true,
|
|
17636
|
+
fields: [
|
|
17637
|
+
{
|
|
17638
|
+
name: "type",
|
|
17639
|
+
type: "string",
|
|
17640
|
+
required: true,
|
|
17641
|
+
description: "Registered node type name from types.list; an unregistered name is refused and nothing is written."
|
|
17642
|
+
},
|
|
17643
|
+
{
|
|
17644
|
+
name: "ref",
|
|
17645
|
+
type: "string",
|
|
17646
|
+
required: false,
|
|
17647
|
+
description: "Id of the mirrored record in the owning service, which must start with the type's ref_prefix; omit or null for a concept with no external record."
|
|
17648
|
+
},
|
|
17649
|
+
{
|
|
17650
|
+
name: "name",
|
|
17651
|
+
type: "string",
|
|
17652
|
+
required: true,
|
|
17653
|
+
description: "Display name of the entity, at most 200 characters."
|
|
17654
|
+
},
|
|
17655
|
+
{
|
|
17656
|
+
name: "aliases",
|
|
17657
|
+
type: "array",
|
|
17658
|
+
itemType: "string",
|
|
17659
|
+
required: false,
|
|
17660
|
+
description: "Other names this entity is known by; they are matched by search alongside the name."
|
|
17661
|
+
},
|
|
17662
|
+
{
|
|
17663
|
+
name: "description",
|
|
17664
|
+
type: "string",
|
|
17665
|
+
required: false,
|
|
17666
|
+
description: "Profile of the entity, at most 500 characters; omit or null for none."
|
|
17667
|
+
},
|
|
17668
|
+
{
|
|
17669
|
+
name: "owner",
|
|
17670
|
+
type: "string",
|
|
17671
|
+
required: false,
|
|
17672
|
+
description: "Member id whose content this is, restricting it to that member; omit or null to make it readable organization-wide."
|
|
17673
|
+
}
|
|
17674
|
+
]
|
|
17675
|
+
}
|
|
17676
|
+
},
|
|
17677
|
+
{
|
|
17678
|
+
resource: "ontology.nodes",
|
|
17679
|
+
method: "retrieve",
|
|
17680
|
+
summary: "Retrieve node",
|
|
17681
|
+
description: "Read one node's content and, with expand=relations, every relation on and around it. as_of reads the node as it was at that time. A node id from another organization, or one that never existed, answers ONTOLOGY_NODE_NOT_FOUND; a node you may reach but not read returns restricted true with its name only.",
|
|
17682
|
+
http: "GET",
|
|
17683
|
+
path: "/ontology/v1/nodes/{node_id}",
|
|
17684
|
+
streaming: "no",
|
|
17685
|
+
pagination: false,
|
|
17686
|
+
pathParams: [
|
|
17687
|
+
{
|
|
17688
|
+
name: "node_id",
|
|
17689
|
+
sdkName: "node_id",
|
|
17690
|
+
description: "Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted."
|
|
17691
|
+
}
|
|
17692
|
+
],
|
|
17693
|
+
query: [
|
|
17694
|
+
{
|
|
17695
|
+
name: "expand",
|
|
17696
|
+
type: "string",
|
|
17697
|
+
enum: [
|
|
17698
|
+
"relations"
|
|
17699
|
+
],
|
|
17700
|
+
required: false,
|
|
17701
|
+
description: "Set to relations to include the node's incoming and outgoing relations in the same response; omit for the node alone."
|
|
17702
|
+
},
|
|
17703
|
+
{
|
|
17704
|
+
name: "as_of",
|
|
17705
|
+
type: "string",
|
|
17706
|
+
required: false,
|
|
17707
|
+
description: "ISO 8601 timestamp; read the node and its relations as they were then, including relations invalidated since. Omit to read current state."
|
|
17708
|
+
}
|
|
17709
|
+
]
|
|
17710
|
+
},
|
|
17711
|
+
{
|
|
17712
|
+
resource: "ontology.nodes",
|
|
17713
|
+
method: "update",
|
|
17714
|
+
summary: "Update node",
|
|
17715
|
+
description: "Change a node's name, aliases or description when the mirrored record was renamed, without touching its type or identity. Send only the fields to change; omitted fields keep their current values and an explicitly null description clears it. Repeating the same edit converges on the same node, so this needs no Idempotency-Key.",
|
|
17716
|
+
http: "PATCH",
|
|
17717
|
+
path: "/ontology/v1/nodes/{node_id}",
|
|
17718
|
+
streaming: "no",
|
|
17719
|
+
pagination: false,
|
|
17720
|
+
pathParams: [
|
|
17721
|
+
{
|
|
17722
|
+
name: "node_id",
|
|
17723
|
+
sdkName: "node_id",
|
|
17724
|
+
description: "Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted."
|
|
17725
|
+
}
|
|
17726
|
+
],
|
|
17727
|
+
query: [],
|
|
17728
|
+
body: {
|
|
17729
|
+
required: true,
|
|
17730
|
+
fields: [
|
|
17731
|
+
{
|
|
17732
|
+
name: "name",
|
|
17733
|
+
type: "string",
|
|
17734
|
+
required: false,
|
|
17735
|
+
description: "New display name, at most 200 characters; omit to keep the current name."
|
|
17736
|
+
},
|
|
17737
|
+
{
|
|
17738
|
+
name: "aliases",
|
|
17739
|
+
type: "array",
|
|
17740
|
+
itemType: "string",
|
|
17741
|
+
required: false,
|
|
17742
|
+
description: "Replacement alias list; an empty array clears the aliases and omitting the field keeps them."
|
|
17743
|
+
},
|
|
17744
|
+
{
|
|
17745
|
+
name: "description",
|
|
17746
|
+
type: "string",
|
|
17747
|
+
required: false,
|
|
17748
|
+
description: "Replacement profile, at most 500 characters; an explicit null clears it and omitting the field keeps it."
|
|
17749
|
+
}
|
|
17750
|
+
]
|
|
17751
|
+
}
|
|
17752
|
+
},
|
|
17753
|
+
{
|
|
17754
|
+
resource: "ontology.nodes.merge",
|
|
17755
|
+
method: "create",
|
|
17756
|
+
summary: "Merge node",
|
|
17757
|
+
description: "Fold a duplicate node into the node that should survive, when two records are discovered to be the same entity. The merged node's relations and aliases move to the survivor and later reads of the duplicate resolve to it. Send an Idempotency-Key header; repeating the same key replays the first result. Reversal is a staff operation, not available here.",
|
|
17758
|
+
http: "POST",
|
|
17759
|
+
path: "/ontology/v1/nodes/{node_id}/merge",
|
|
17760
|
+
streaming: "no",
|
|
17761
|
+
pagination: false,
|
|
17762
|
+
pathParams: [
|
|
17763
|
+
{
|
|
17764
|
+
name: "node_id",
|
|
17765
|
+
sdkName: "node_id",
|
|
17766
|
+
description: "Node id returned by nodes.list, nodes.create or a changeset, in the form ond_ followed by 32 lowercase letters or digits; a name or an external record id is not accepted."
|
|
17767
|
+
}
|
|
17768
|
+
],
|
|
17769
|
+
query: [],
|
|
17770
|
+
body: {
|
|
17771
|
+
required: true,
|
|
17772
|
+
fields: [
|
|
17773
|
+
{
|
|
17774
|
+
name: "into",
|
|
17775
|
+
type: "string",
|
|
17776
|
+
required: true,
|
|
17777
|
+
description: "Node id that should survive, from nodes.list or search; the merged node's relations and aliases move to it."
|
|
17778
|
+
}
|
|
17779
|
+
]
|
|
17780
|
+
}
|
|
17781
|
+
},
|
|
17782
|
+
{
|
|
17783
|
+
resource: "ontology.relations",
|
|
17784
|
+
method: "list",
|
|
17785
|
+
summary: "List relations",
|
|
17786
|
+
description: "Read the facts in the graph and obtain relation ids for retrieval, invalidation or spreading. Filter by endpoint node, by type and by direction; as_of reads the relations as they were then. Invalidated relations are omitted unless include_invalid is true. limit is 1–100 and defaults to 50; follow next_cursor until it is null.",
|
|
17787
|
+
http: "GET",
|
|
17788
|
+
path: "/ontology/v1/relations",
|
|
17789
|
+
streaming: "no",
|
|
17790
|
+
pagination: true,
|
|
17791
|
+
pathParams: [],
|
|
17792
|
+
query: [
|
|
17793
|
+
{
|
|
17794
|
+
name: "node",
|
|
17795
|
+
type: "string",
|
|
17796
|
+
required: false,
|
|
17797
|
+
description: "A node id from nodes.list or nodes.create; returns the relations this node takes part in, narrowed by direction. Omit to list relations between every node."
|
|
17798
|
+
},
|
|
17799
|
+
{
|
|
17800
|
+
name: "type",
|
|
17801
|
+
type: "array",
|
|
17802
|
+
itemType: "string",
|
|
17803
|
+
required: false,
|
|
17804
|
+
description: "Repeat to filter to any of several registered relation type names, for example type=references&type=serves; omit to list every type."
|
|
17805
|
+
},
|
|
17806
|
+
{
|
|
17807
|
+
name: "direction",
|
|
17808
|
+
type: "string",
|
|
17809
|
+
enum: [
|
|
17810
|
+
"out",
|
|
17811
|
+
"in",
|
|
17812
|
+
"both"
|
|
17813
|
+
],
|
|
17814
|
+
required: false,
|
|
17815
|
+
description: "Which side of node to follow; out returns relations the node is the source of, in returns those it is the target of. Only meaningful together with node."
|
|
17816
|
+
},
|
|
17817
|
+
{
|
|
17818
|
+
name: "as_of",
|
|
17819
|
+
type: "string",
|
|
17820
|
+
required: false,
|
|
17821
|
+
description: "ISO 8601 timestamp; read relations as they were then, so one recorded or invalidated later is judged by that time. Omit to read current state."
|
|
17822
|
+
},
|
|
17823
|
+
{
|
|
17824
|
+
name: "include_invalid",
|
|
17825
|
+
type: "boolean",
|
|
17826
|
+
required: false,
|
|
17827
|
+
description: "Set true to include relations whose invalid_at has passed, which is how a relation that stopped being true stays readable. Omit or false for currently valid relations only."
|
|
17828
|
+
},
|
|
17829
|
+
{
|
|
17830
|
+
name: "limit",
|
|
17831
|
+
type: "integer",
|
|
17832
|
+
required: false,
|
|
17833
|
+
description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100."
|
|
17834
|
+
},
|
|
17835
|
+
{
|
|
17836
|
+
name: "cursor",
|
|
17837
|
+
type: "string",
|
|
17838
|
+
required: false,
|
|
17839
|
+
description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
|
|
17840
|
+
}
|
|
17841
|
+
]
|
|
17842
|
+
},
|
|
17843
|
+
{
|
|
17844
|
+
resource: "ontology.relations",
|
|
17845
|
+
method: "create",
|
|
17846
|
+
summary: "Create relation",
|
|
17847
|
+
description: "Record one fact between two existing nodes, for a system mirroring a relationship it owns. type must be registered and must admit these endpoints; fact states the relationship in one sentence. Send an Idempotency-Key header; repeating the same key returns the first result instead of writing a second relation. This writes structure only — to give an agent something to remember, use POST /agent/v1/agents/{agent_id}/consolidations.",
|
|
17848
|
+
http: "POST",
|
|
17849
|
+
path: "/ontology/v1/relations",
|
|
17850
|
+
streaming: "no",
|
|
17851
|
+
pagination: false,
|
|
17852
|
+
pathParams: [],
|
|
17853
|
+
query: [],
|
|
17854
|
+
body: {
|
|
17855
|
+
required: true,
|
|
17856
|
+
fields: [
|
|
17857
|
+
{
|
|
17858
|
+
name: "type",
|
|
17859
|
+
type: "string",
|
|
17860
|
+
required: true,
|
|
17861
|
+
description: "Registered relation type name from types.list; it must admit both endpoints or the write is refused."
|
|
17862
|
+
},
|
|
17863
|
+
{
|
|
17864
|
+
name: "source",
|
|
17865
|
+
type: "string",
|
|
17866
|
+
required: true,
|
|
17867
|
+
description: "Node id the fact starts from, from nodes.list or nodes.create."
|
|
17868
|
+
},
|
|
17869
|
+
{
|
|
17870
|
+
name: "target",
|
|
17871
|
+
type: "string",
|
|
17872
|
+
required: true,
|
|
17873
|
+
description: "Node id the fact points at, from nodes.list or nodes.create."
|
|
17874
|
+
},
|
|
17875
|
+
{
|
|
17876
|
+
name: "fact",
|
|
17877
|
+
type: "string",
|
|
17878
|
+
required: true,
|
|
17879
|
+
description: "The relationship in one sentence, at most 280 characters, written to read back on its own."
|
|
17880
|
+
},
|
|
17881
|
+
{
|
|
17882
|
+
name: "valid_at",
|
|
17883
|
+
type: "string",
|
|
17884
|
+
required: false,
|
|
17885
|
+
description: "World time the fact became true, when the mirrored record dates it; omit to leave it undated."
|
|
17886
|
+
},
|
|
17887
|
+
{
|
|
17888
|
+
name: "owner",
|
|
17889
|
+
type: "string",
|
|
17890
|
+
required: false,
|
|
17891
|
+
description: "Member id whose content this fact is, restricting it to that member; omit or null for organization-wide."
|
|
17892
|
+
}
|
|
17893
|
+
]
|
|
17894
|
+
}
|
|
17895
|
+
},
|
|
17896
|
+
{
|
|
17897
|
+
resource: "ontology.relations",
|
|
17898
|
+
method: "retrieve",
|
|
17899
|
+
summary: "Retrieve relation",
|
|
17900
|
+
description: "Read one relation's fact and both of its clocks — valid_at and invalid_at for when it was true in the world, created_at and expired_at for when it was recorded and retired. An id from another organization, or one that never existed, answers ONTOLOGY_EDGE_NOT_FOUND.",
|
|
17901
|
+
http: "GET",
|
|
17902
|
+
path: "/ontology/v1/relations/{relation_id}",
|
|
17903
|
+
streaming: "no",
|
|
17904
|
+
pagination: false,
|
|
17905
|
+
pathParams: [
|
|
17906
|
+
{
|
|
17907
|
+
name: "relation_id",
|
|
17908
|
+
sdkName: "relation_id",
|
|
17909
|
+
description: "Relation id returned by relations.list, relations.create or a changeset, in the form oed_ followed by 32 lowercase letters or digits; a node id is not accepted."
|
|
17910
|
+
}
|
|
17911
|
+
],
|
|
17912
|
+
query: []
|
|
17913
|
+
},
|
|
17914
|
+
{
|
|
17915
|
+
resource: "ontology.relations.invalidate",
|
|
17916
|
+
method: "create",
|
|
17917
|
+
summary: "Invalidate relation",
|
|
17918
|
+
description: "Mark a relation as no longer true from a world time, when the mirrored record changed. The relation is kept — invalid_at moves and the relation still reads at an earlier as_of, so history stays answerable. Send an Idempotency-Key header; repeating the same key replays the first result. There is no delete.",
|
|
17919
|
+
http: "POST",
|
|
17920
|
+
path: "/ontology/v1/relations/{relation_id}/invalidate",
|
|
17921
|
+
streaming: "no",
|
|
17922
|
+
pagination: false,
|
|
17923
|
+
pathParams: [
|
|
17924
|
+
{
|
|
17925
|
+
name: "relation_id",
|
|
17926
|
+
sdkName: "relation_id",
|
|
17927
|
+
description: "Relation id returned by relations.list, relations.create or a changeset, in the form oed_ followed by 32 lowercase letters or digits; a node id is not accepted."
|
|
17928
|
+
}
|
|
17929
|
+
],
|
|
17930
|
+
query: [],
|
|
17931
|
+
body: {
|
|
17932
|
+
required: true,
|
|
17933
|
+
fields: [
|
|
17934
|
+
{
|
|
17935
|
+
name: "invalid_at",
|
|
17936
|
+
type: "string",
|
|
17937
|
+
required: true,
|
|
17938
|
+
description: "World time the fact stopped being true, in ISO 8601 UTC; reads at an earlier as_of still return the relation."
|
|
17939
|
+
},
|
|
17940
|
+
{
|
|
17941
|
+
name: "superseded_by",
|
|
17942
|
+
type: "string",
|
|
17943
|
+
required: false,
|
|
17944
|
+
description: "Relation id that replaces this one, when a successor was recorded; omit or null when nothing replaced it."
|
|
17945
|
+
},
|
|
17946
|
+
{
|
|
17947
|
+
name: "reason",
|
|
17948
|
+
type: "string",
|
|
17949
|
+
required: false,
|
|
17950
|
+
description: "Why it stopped being true, for people reading the history later; not enforced and safe to omit."
|
|
17951
|
+
}
|
|
17952
|
+
]
|
|
17953
|
+
}
|
|
17954
|
+
},
|
|
17955
|
+
{
|
|
17956
|
+
resource: "ontology.search",
|
|
17957
|
+
method: "create",
|
|
17958
|
+
summary: "Search nodes",
|
|
17959
|
+
description: "Resolve text to the nodes it most likely names, when a mirror holds a name and needs the node id it corresponds to. Results are ranked candidates, not an answer, each reporting whether the match came from the node's name, an alias, its description or a relation's fact. Narrow with types, and cap the result count with limit (1–50, default 20). This reads structure; it is not an agent recall — agents recall through POST /agent/v1/agents/{agent_id}/consolidations.",
|
|
17960
|
+
http: "POST",
|
|
17961
|
+
path: "/ontology/v1/search",
|
|
17962
|
+
streaming: "no",
|
|
17963
|
+
pagination: false,
|
|
17964
|
+
pathParams: [],
|
|
17965
|
+
query: [],
|
|
17966
|
+
body: {
|
|
17967
|
+
required: true,
|
|
17968
|
+
fields: [
|
|
17969
|
+
{
|
|
17970
|
+
name: "text",
|
|
17971
|
+
type: "string",
|
|
17972
|
+
required: true,
|
|
17973
|
+
description: "Text to find nodes for, matched against names, aliases, descriptions and relation facts; an empty string is refused."
|
|
17974
|
+
},
|
|
17975
|
+
{
|
|
17976
|
+
name: "types",
|
|
17977
|
+
type: "array",
|
|
17978
|
+
itemType: "string",
|
|
17979
|
+
required: false,
|
|
17980
|
+
description: "Registered node type names to search within; omit to search every type."
|
|
17981
|
+
},
|
|
17982
|
+
{
|
|
17983
|
+
name: "window",
|
|
17984
|
+
type: "object",
|
|
17985
|
+
required: false,
|
|
17986
|
+
description: "Restrict matches to facts recorded within a period; omit to search all time."
|
|
17987
|
+
},
|
|
17988
|
+
{
|
|
17989
|
+
name: "limit",
|
|
17990
|
+
type: "integer",
|
|
17991
|
+
required: false,
|
|
17992
|
+
description: "Maximum candidate nodes to return, from 1 to 50; defaults to 20 when omitted."
|
|
17993
|
+
}
|
|
17994
|
+
]
|
|
17995
|
+
}
|
|
17996
|
+
},
|
|
17997
|
+
{
|
|
17998
|
+
resource: "ontology.types",
|
|
17999
|
+
method: "list",
|
|
18000
|
+
summary: "List types",
|
|
18001
|
+
description: "Read the node and relation types registered for this organization before writing, so a create names a type the graph accepts. Each entry is one registrant's registration with its owner, version and definitions. Types cannot be created at runtime; they are registered by the owning service at deploy time, so a type missing here is not available to write.",
|
|
18002
|
+
http: "GET",
|
|
18003
|
+
path: "/ontology/v1/types",
|
|
18004
|
+
streaming: "no",
|
|
18005
|
+
pagination: false,
|
|
18006
|
+
pathParams: [],
|
|
18007
|
+
query: []
|
|
18008
|
+
},
|
|
18009
|
+
{
|
|
18010
|
+
resource: "ontology.types",
|
|
18011
|
+
method: "create",
|
|
18012
|
+
summary: "Register type",
|
|
18013
|
+
description: "Register a node or relation type for this organization. Not open yet — this call currently answers 501 NOT_IMPLEMENTED and writes nothing, because a registration is checked and stored by the deploy gate that ships the registering service, not by a runtime call. Until it opens, read the types already in force with praxis.ontology.types.list and create records only of those types.",
|
|
18014
|
+
http: "POST",
|
|
18015
|
+
path: "/ontology/v1/types",
|
|
18016
|
+
streaming: "no",
|
|
18017
|
+
pagination: false,
|
|
18018
|
+
pathParams: [],
|
|
18019
|
+
query: [],
|
|
18020
|
+
body: {
|
|
18021
|
+
required: true,
|
|
18022
|
+
fields: [
|
|
18023
|
+
{
|
|
18024
|
+
name: "owner",
|
|
18025
|
+
type: "string",
|
|
18026
|
+
required: true,
|
|
18027
|
+
description: "Service that registered these types, for example file or ticket; it is the registrant a later change to a type is checked against."
|
|
18028
|
+
},
|
|
18029
|
+
{
|
|
18030
|
+
name: "version",
|
|
18031
|
+
type: "integer",
|
|
18032
|
+
required: true,
|
|
18033
|
+
description: "Monotonic version of this owner's registration; a later registration must extend this one without removing or narrowing anything."
|
|
18034
|
+
},
|
|
18035
|
+
{
|
|
18036
|
+
name: "nodes",
|
|
18037
|
+
type: "array",
|
|
18038
|
+
itemType: "object",
|
|
18039
|
+
required: true,
|
|
18040
|
+
description: "Node types this owner registers."
|
|
18041
|
+
},
|
|
18042
|
+
{
|
|
18043
|
+
name: "edges",
|
|
18044
|
+
type: "array",
|
|
18045
|
+
itemType: "object",
|
|
18046
|
+
required: true,
|
|
18047
|
+
description: "Relation types this owner registers."
|
|
18048
|
+
}
|
|
18049
|
+
]
|
|
18050
|
+
}
|
|
18051
|
+
},
|
|
18052
|
+
{
|
|
18053
|
+
resource: "ontology.types",
|
|
18054
|
+
method: "retrieve",
|
|
18055
|
+
summary: "Retrieve type",
|
|
18056
|
+
description: "Read one registered type's definition before writing a record of it, to learn whether it is a node or an edge, which endpoints an edge type admits, and which origins it accepts. The name comes from types.list; a name that is not registered answers ONTOLOGY_TYPE_UNKNOWN, and writes of that type are refused.",
|
|
18057
|
+
http: "GET",
|
|
18058
|
+
path: "/ontology/v1/types/{name}",
|
|
18059
|
+
streaming: "no",
|
|
18060
|
+
pagination: false,
|
|
18061
|
+
pathParams: [
|
|
18062
|
+
{
|
|
18063
|
+
name: "name",
|
|
18064
|
+
sdkName: "name",
|
|
18065
|
+
description: "A type name from types.list, with its dots preserved — a display label is not accepted."
|
|
18066
|
+
}
|
|
18067
|
+
],
|
|
18068
|
+
query: []
|
|
18069
|
+
},
|
|
16350
18070
|
{
|
|
16351
18071
|
resource: "organization.charges",
|
|
16352
18072
|
method: "list",
|
|
@@ -19070,7 +20790,7 @@ for more details.`
|
|
|
19070
20790
|
resource: "ticket.labels",
|
|
19071
20791
|
method: "create",
|
|
19072
20792
|
summary: "Create or add labels",
|
|
19073
|
-
description: "Create or add labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result.
|
|
20793
|
+
description: "Create or add labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
19074
20794
|
http: "POST",
|
|
19075
20795
|
path: "/ticket/v1/labels",
|
|
19076
20796
|
streaming: "no",
|
|
@@ -19112,7 +20832,7 @@ for more details.`
|
|
|
19112
20832
|
resource: "ticket.labels",
|
|
19113
20833
|
method: "delete",
|
|
19114
20834
|
summary: "Remove labels",
|
|
19115
|
-
description: "Remove labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result.
|
|
20835
|
+
description: "Remove labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
19116
20836
|
http: "DELETE",
|
|
19117
20837
|
path: "/ticket/v1/labels/{name}",
|
|
19118
20838
|
streaming: "no",
|
|
@@ -19137,7 +20857,7 @@ for more details.`
|
|
|
19137
20857
|
resource: "ticket.labels",
|
|
19138
20858
|
method: "update",
|
|
19139
20859
|
summary: "Update labels",
|
|
19140
|
-
description: "Update labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result.
|
|
20860
|
+
description: "Update labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
19141
20861
|
http: "PATCH",
|
|
19142
20862
|
path: "/ticket/v1/labels/{name}",
|
|
19143
20863
|
streaming: "no",
|
|
@@ -19433,7 +21153,7 @@ for more details.`
|
|
|
19433
21153
|
name: "filter",
|
|
19434
21154
|
type: "string",
|
|
19435
21155
|
required: false,
|
|
19436
|
-
description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort;
|
|
21156
|
+
description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort; write each qualifier as field:value (for example, is:open milestone:5), never field=value. Unknown qualifiers return INVALID_PARAMS. Passed unchanged to the service."
|
|
19437
21157
|
}
|
|
19438
21158
|
]
|
|
19439
21159
|
},
|
|
@@ -20539,7 +22259,7 @@ for more details.`
|
|
|
20539
22259
|
resource: "vault.vaults",
|
|
20540
22260
|
method: "create",
|
|
20541
22261
|
summary: "Create vault",
|
|
20542
|
-
description: "Create an empty, active vault to hold credentials for your account, with a display name and optional metadata. Use its returned id as vault_id when creating secrets or OAuth authorizations.
|
|
22262
|
+
description: "Create an empty, active vault to hold credentials for your account, with a display name and optional metadata. Use its returned id as vault_id when creating secrets or OAuth authorizations. Agent sessions and deployments accept up to 50 vault_ids and match their credentials against the session's MCP servers, so a stored static or oauth credential does serve as vault-backed MCP authentication; only environment_variable credentials are not yet placed, because the egress proxy ADR-058 §6 gives them is not built. Application vault references are also unavailable; praxis_vault_ref version bindings and secret writes with a vault source return 501, so creating a vault does not yet enable either consumer.",
|
|
20543
22263
|
http: "POST",
|
|
20544
22264
|
path: "/vault/v1/vaults",
|
|
20545
22265
|
streaming: "no",
|
|
@@ -21072,6 +22792,8 @@ function problemFrom(status, headers, body, statusText) {
|
|
|
21072
22792
|
param: typeof param === "string" ? param : param === null || nested.param === null ? null : undefined,
|
|
21073
22793
|
errors: Array.isArray(value.errors) ? value.errors : [],
|
|
21074
22794
|
requestId: headers.get("x-request-id") ?? string(value.requestId) ?? string(value.request_id),
|
|
22795
|
+
docUrl: string(nested.doc_url) ?? string(value.doc_url) ?? string(nested.docUrl) ?? string(value.docUrl),
|
|
22796
|
+
describe: string(nested.describe) ?? string(value.describe),
|
|
21075
22797
|
raw: body
|
|
21076
22798
|
};
|
|
21077
22799
|
}
|
|
@@ -21085,6 +22807,8 @@ class PraxisError extends Error {
|
|
|
21085
22807
|
errors;
|
|
21086
22808
|
requestId;
|
|
21087
22809
|
param;
|
|
22810
|
+
docUrl;
|
|
22811
|
+
describe;
|
|
21088
22812
|
raw;
|
|
21089
22813
|
constructor(problem = {}, options) {
|
|
21090
22814
|
super(problem.message ?? problem.detail ?? problem.title ?? `Praxis request failed${problem.status ? ` (${problem.status})` : ""}`, options);
|
|
@@ -21097,6 +22821,8 @@ class PraxisError extends Error {
|
|
|
21097
22821
|
this.errors = problem.errors ?? [];
|
|
21098
22822
|
this.requestId = problem.requestId;
|
|
21099
22823
|
this.param = problem.param;
|
|
22824
|
+
this.docUrl = problem.docUrl;
|
|
22825
|
+
this.describe = problem.describe;
|
|
21100
22826
|
this.raw = problem.raw;
|
|
21101
22827
|
}
|
|
21102
22828
|
static fromResponse(response, body) {
|
|
@@ -22501,6 +24227,23 @@ var computersFilesContent = (options) => (options.client ?? client).get({
|
|
|
22501
24227
|
url: "/agent/v1/computers/{computer_id}/files/content",
|
|
22502
24228
|
...options
|
|
22503
24229
|
});
|
|
24230
|
+
var computersFilesConvert = (options) => (options.client ?? client).post({
|
|
24231
|
+
security: [{
|
|
24232
|
+
key: "BearerAuth",
|
|
24233
|
+
scheme: "bearer",
|
|
24234
|
+
type: "http"
|
|
24235
|
+
}, {
|
|
24236
|
+
key: "ApiKeyAuth",
|
|
24237
|
+
name: "X-API-Key",
|
|
24238
|
+
type: "apiKey"
|
|
24239
|
+
}],
|
|
24240
|
+
url: "/agent/v1/computers/{computer_id}/files/convert",
|
|
24241
|
+
...options,
|
|
24242
|
+
headers: {
|
|
24243
|
+
"Content-Type": "application/json",
|
|
24244
|
+
...options.headers
|
|
24245
|
+
}
|
|
24246
|
+
});
|
|
22504
24247
|
var connectComputer = (options) => (options.client ?? client).post({
|
|
22505
24248
|
security: [{
|
|
22506
24249
|
key: "BearerAuth",
|
|
@@ -22999,6 +24742,15 @@ var fileCancelUpload = (options) => (options.client ?? client).post({
|
|
|
22999
24742
|
url: "/file/v1/uploads/{upload_id}/cancel",
|
|
23000
24743
|
...options
|
|
23001
24744
|
});
|
|
24745
|
+
var fileRetrieveUpload = (options) => (options.client ?? client).get({
|
|
24746
|
+
security: [{
|
|
24747
|
+
key: "BearerAuth",
|
|
24748
|
+
scheme: "bearer",
|
|
24749
|
+
type: "http"
|
|
24750
|
+
}],
|
|
24751
|
+
url: "/file/v1/uploads/{upload_id}",
|
|
24752
|
+
...options
|
|
24753
|
+
});
|
|
23002
24754
|
var fileCreateSignedUpload = (options) => (options.client ?? client).post({
|
|
23003
24755
|
security: [{
|
|
23004
24756
|
key: "BearerAuth",
|
|
@@ -26875,6 +28627,36 @@ var cutCreateExport = (options) => (options.client ?? client).post({
|
|
|
26875
28627
|
...options.headers
|
|
26876
28628
|
}
|
|
26877
28629
|
});
|
|
28630
|
+
var cutCreateRender = (options) => (options.client ?? client).post({
|
|
28631
|
+
security: [{
|
|
28632
|
+
key: "BearerAuth",
|
|
28633
|
+
scheme: "bearer",
|
|
28634
|
+
type: "http"
|
|
28635
|
+
}, {
|
|
28636
|
+
key: "ApiKeyAuth",
|
|
28637
|
+
name: "X-API-Key",
|
|
28638
|
+
type: "apiKey"
|
|
28639
|
+
}],
|
|
28640
|
+
url: "/cut/v1/projects/{project_id}/renders",
|
|
28641
|
+
...options,
|
|
28642
|
+
headers: {
|
|
28643
|
+
"Content-Type": "application/json",
|
|
28644
|
+
...options.headers
|
|
28645
|
+
}
|
|
28646
|
+
});
|
|
28647
|
+
var cutRetrieveRender = (options) => (options.client ?? client).get({
|
|
28648
|
+
security: [{
|
|
28649
|
+
key: "BearerAuth",
|
|
28650
|
+
scheme: "bearer",
|
|
28651
|
+
type: "http"
|
|
28652
|
+
}, {
|
|
28653
|
+
key: "ApiKeyAuth",
|
|
28654
|
+
name: "X-API-Key",
|
|
28655
|
+
type: "apiKey"
|
|
28656
|
+
}],
|
|
28657
|
+
url: "/cut/v1/renders/{render_id}",
|
|
28658
|
+
...options
|
|
28659
|
+
});
|
|
26878
28660
|
var cutRetrieveExport = (options) => (options.client ?? client).get({
|
|
26879
28661
|
security: [{
|
|
26880
28662
|
key: "BearerAuth",
|
|
@@ -27165,6 +28947,201 @@ var databaseInsert = (options) => (options.client ?? client).post({
|
|
|
27165
28947
|
...options.headers
|
|
27166
28948
|
}
|
|
27167
28949
|
});
|
|
28950
|
+
var devopsTestCatalogGet = (options) => (options.client ?? client).get({
|
|
28951
|
+
security: [{
|
|
28952
|
+
key: "devops-bearerAuth",
|
|
28953
|
+
scheme: "bearer",
|
|
28954
|
+
type: "http"
|
|
28955
|
+
}],
|
|
28956
|
+
url: "/devops/v1/projects/{project}/test-catalog",
|
|
28957
|
+
...options
|
|
28958
|
+
});
|
|
28959
|
+
var devopsTestSuitesList = (options) => (options.client ?? client).get({
|
|
28960
|
+
security: [{
|
|
28961
|
+
key: "devops-bearerAuth",
|
|
28962
|
+
scheme: "bearer",
|
|
28963
|
+
type: "http"
|
|
28964
|
+
}],
|
|
28965
|
+
url: "/devops/v1/projects/{project}/test-suites",
|
|
28966
|
+
...options
|
|
28967
|
+
});
|
|
28968
|
+
var devopsTestSuitesGet = (options) => (options.client ?? client).get({
|
|
28969
|
+
security: [{
|
|
28970
|
+
key: "devops-bearerAuth",
|
|
28971
|
+
scheme: "bearer",
|
|
28972
|
+
type: "http"
|
|
28973
|
+
}],
|
|
28974
|
+
url: "/devops/v1/test-suites/{id}",
|
|
28975
|
+
...options
|
|
28976
|
+
});
|
|
28977
|
+
var devopsTestCasesList = (options) => (options.client ?? client).get({
|
|
28978
|
+
security: [{
|
|
28979
|
+
key: "devops-bearerAuth",
|
|
28980
|
+
scheme: "bearer",
|
|
28981
|
+
type: "http"
|
|
28982
|
+
}],
|
|
28983
|
+
url: "/devops/v1/projects/{project}/test-cases",
|
|
28984
|
+
...options
|
|
28985
|
+
});
|
|
28986
|
+
var devopsTestCasesGet = (options) => (options.client ?? client).get({
|
|
28987
|
+
security: [{
|
|
28988
|
+
key: "devops-bearerAuth",
|
|
28989
|
+
scheme: "bearer",
|
|
28990
|
+
type: "http"
|
|
28991
|
+
}],
|
|
28992
|
+
url: "/devops/v1/test-cases/{id}",
|
|
28993
|
+
...options
|
|
28994
|
+
});
|
|
28995
|
+
var devopsTestPlansList = (options) => (options.client ?? client).get({
|
|
28996
|
+
security: [{
|
|
28997
|
+
key: "devops-bearerAuth",
|
|
28998
|
+
scheme: "bearer",
|
|
28999
|
+
type: "http"
|
|
29000
|
+
}],
|
|
29001
|
+
url: "/devops/v1/projects/{project}/test-plans",
|
|
29002
|
+
...options
|
|
29003
|
+
});
|
|
29004
|
+
var devopsTestPlansCreate = (options) => (options.client ?? client).post({
|
|
29005
|
+
security: [{
|
|
29006
|
+
key: "devops-bearerAuth",
|
|
29007
|
+
scheme: "bearer",
|
|
29008
|
+
type: "http"
|
|
29009
|
+
}],
|
|
29010
|
+
url: "/devops/v1/projects/{project}/test-plans",
|
|
29011
|
+
...options,
|
|
29012
|
+
headers: {
|
|
29013
|
+
"Content-Type": "application/json",
|
|
29014
|
+
...options.headers
|
|
29015
|
+
}
|
|
29016
|
+
});
|
|
29017
|
+
var devopsTestPlansDelete = (options) => (options.client ?? client).delete({
|
|
29018
|
+
security: [{
|
|
29019
|
+
key: "devops-bearerAuth",
|
|
29020
|
+
scheme: "bearer",
|
|
29021
|
+
type: "http"
|
|
29022
|
+
}],
|
|
29023
|
+
url: "/devops/v1/test-plans/{id}",
|
|
29024
|
+
...options
|
|
29025
|
+
});
|
|
29026
|
+
var devopsTestPlansGet = (options) => (options.client ?? client).get({
|
|
29027
|
+
security: [{
|
|
29028
|
+
key: "devops-bearerAuth",
|
|
29029
|
+
scheme: "bearer",
|
|
29030
|
+
type: "http"
|
|
29031
|
+
}],
|
|
29032
|
+
url: "/devops/v1/test-plans/{id}",
|
|
29033
|
+
...options
|
|
29034
|
+
});
|
|
29035
|
+
var devopsTestPlansUpdate = (options) => (options.client ?? client).patch({
|
|
29036
|
+
security: [{
|
|
29037
|
+
key: "devops-bearerAuth",
|
|
29038
|
+
scheme: "bearer",
|
|
29039
|
+
type: "http"
|
|
29040
|
+
}],
|
|
29041
|
+
url: "/devops/v1/test-plans/{id}",
|
|
29042
|
+
...options,
|
|
29043
|
+
headers: {
|
|
29044
|
+
"Content-Type": "application/json",
|
|
29045
|
+
...options.headers
|
|
29046
|
+
}
|
|
29047
|
+
});
|
|
29048
|
+
var devopsTestPlansPause = (options) => (options.client ?? client).post({
|
|
29049
|
+
security: [{
|
|
29050
|
+
key: "devops-bearerAuth",
|
|
29051
|
+
scheme: "bearer",
|
|
29052
|
+
type: "http"
|
|
29053
|
+
}],
|
|
29054
|
+
url: "/devops/v1/test-plans/{id}:pause",
|
|
29055
|
+
...options,
|
|
29056
|
+
headers: {
|
|
29057
|
+
"Content-Type": "application/json",
|
|
29058
|
+
...options.headers
|
|
29059
|
+
}
|
|
29060
|
+
});
|
|
29061
|
+
var devopsTestPlansResume = (options) => (options.client ?? client).post({
|
|
29062
|
+
security: [{
|
|
29063
|
+
key: "devops-bearerAuth",
|
|
29064
|
+
scheme: "bearer",
|
|
29065
|
+
type: "http"
|
|
29066
|
+
}],
|
|
29067
|
+
url: "/devops/v1/test-plans/{id}:resume",
|
|
29068
|
+
...options
|
|
29069
|
+
});
|
|
29070
|
+
var devopsTestRunsList = (options) => (options.client ?? client).get({
|
|
29071
|
+
security: [{
|
|
29072
|
+
key: "devops-bearerAuth",
|
|
29073
|
+
scheme: "bearer",
|
|
29074
|
+
type: "http"
|
|
29075
|
+
}],
|
|
29076
|
+
url: "/devops/v1/projects/{project}/test-runs",
|
|
29077
|
+
...options
|
|
29078
|
+
});
|
|
29079
|
+
var devopsTestRunsCreate = (options) => (options.client ?? client).post({
|
|
29080
|
+
security: [{
|
|
29081
|
+
key: "devops-bearerAuth",
|
|
29082
|
+
scheme: "bearer",
|
|
29083
|
+
type: "http"
|
|
29084
|
+
}],
|
|
29085
|
+
url: "/devops/v1/projects/{project}/test-runs",
|
|
29086
|
+
...options,
|
|
29087
|
+
headers: {
|
|
29088
|
+
"Content-Type": "application/json",
|
|
29089
|
+
...options.headers
|
|
29090
|
+
}
|
|
29091
|
+
});
|
|
29092
|
+
var devopsTestRunsGet = (options) => (options.client ?? client).get({
|
|
29093
|
+
security: [{
|
|
29094
|
+
key: "devops-bearerAuth",
|
|
29095
|
+
scheme: "bearer",
|
|
29096
|
+
type: "http"
|
|
29097
|
+
}],
|
|
29098
|
+
url: "/devops/v1/test-runs/{id}",
|
|
29099
|
+
...options
|
|
29100
|
+
});
|
|
29101
|
+
var devopsTestRunsCancel = (options) => (options.client ?? client).post({
|
|
29102
|
+
security: [{
|
|
29103
|
+
key: "devops-bearerAuth",
|
|
29104
|
+
scheme: "bearer",
|
|
29105
|
+
type: "http"
|
|
29106
|
+
}],
|
|
29107
|
+
url: "/devops/v1/test-runs/{id}:cancel",
|
|
29108
|
+
...options,
|
|
29109
|
+
headers: {
|
|
29110
|
+
"Content-Type": "application/json",
|
|
29111
|
+
...options.headers
|
|
29112
|
+
}
|
|
29113
|
+
});
|
|
29114
|
+
var devopsTestExecutionsList = (options) => (options.client ?? client).get({
|
|
29115
|
+
security: [{
|
|
29116
|
+
key: "devops-bearerAuth",
|
|
29117
|
+
scheme: "bearer",
|
|
29118
|
+
type: "http"
|
|
29119
|
+
}],
|
|
29120
|
+
url: "/devops/v1/test-runs/{run}/executions",
|
|
29121
|
+
...options
|
|
29122
|
+
});
|
|
29123
|
+
var devopsTestExecutionsGet = (options) => (options.client ?? client).get({
|
|
29124
|
+
security: [{
|
|
29125
|
+
key: "devops-bearerAuth",
|
|
29126
|
+
scheme: "bearer",
|
|
29127
|
+
type: "http"
|
|
29128
|
+
}],
|
|
29129
|
+
url: "/devops/v1/test-runs/{run}/executions/{case}",
|
|
29130
|
+
...options
|
|
29131
|
+
});
|
|
29132
|
+
var devopsTestReportsUpload = (options) => (options.client ?? client).post({
|
|
29133
|
+
security: [{
|
|
29134
|
+
key: "devops-bearerAuth",
|
|
29135
|
+
scheme: "bearer",
|
|
29136
|
+
type: "http"
|
|
29137
|
+
}],
|
|
29138
|
+
url: "/devops/v1/projects/{project}/test-reports",
|
|
29139
|
+
...options,
|
|
29140
|
+
headers: {
|
|
29141
|
+
"Content-Type": "application/json",
|
|
29142
|
+
...options.headers
|
|
29143
|
+
}
|
|
29144
|
+
});
|
|
27168
29145
|
var knowledgeListVectorStores = (options) => (options?.client ?? client).get({
|
|
27169
29146
|
security: [{
|
|
27170
29147
|
key: "knowledge-bearerAuth",
|
|
@@ -27704,6 +29681,217 @@ var mediaListUnderstandingsByLibrary = (options) => (options.client ?? client).g
|
|
|
27704
29681
|
url: "/media/v1/libraries/{library_id}/understandings",
|
|
27705
29682
|
...options
|
|
27706
29683
|
});
|
|
29684
|
+
var mediaCreateGeneration = (options) => (options.client ?? client).post({
|
|
29685
|
+
security: [{
|
|
29686
|
+
key: "media-BearerAuth",
|
|
29687
|
+
scheme: "bearer",
|
|
29688
|
+
type: "http"
|
|
29689
|
+
}],
|
|
29690
|
+
url: "/media/v1/libraries/{library_id}/generations",
|
|
29691
|
+
...options,
|
|
29692
|
+
headers: {
|
|
29693
|
+
"Content-Type": "application/json",
|
|
29694
|
+
...options.headers
|
|
29695
|
+
}
|
|
29696
|
+
});
|
|
29697
|
+
var mediaListJobs = (options) => (options.client ?? client).get({
|
|
29698
|
+
security: [{
|
|
29699
|
+
key: "media-BearerAuth",
|
|
29700
|
+
scheme: "bearer",
|
|
29701
|
+
type: "http"
|
|
29702
|
+
}],
|
|
29703
|
+
url: "/media/v1/libraries/{library_id}/jobs",
|
|
29704
|
+
...options
|
|
29705
|
+
});
|
|
29706
|
+
var mediaCancelJob = (options) => (options.client ?? client).post({
|
|
29707
|
+
security: [{
|
|
29708
|
+
key: "media-BearerAuth",
|
|
29709
|
+
scheme: "bearer",
|
|
29710
|
+
type: "http"
|
|
29711
|
+
}],
|
|
29712
|
+
url: "/media/v1/libraries/{library_id}/jobs/{job_id}/cancel",
|
|
29713
|
+
...options
|
|
29714
|
+
});
|
|
29715
|
+
var mediaSaveGenerationOutput = (options) => (options.client ?? client).post({
|
|
29716
|
+
security: [{
|
|
29717
|
+
key: "media-BearerAuth",
|
|
29718
|
+
scheme: "bearer",
|
|
29719
|
+
type: "http"
|
|
29720
|
+
}],
|
|
29721
|
+
url: "/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save",
|
|
29722
|
+
...options,
|
|
29723
|
+
headers: {
|
|
29724
|
+
"Content-Type": "application/json",
|
|
29725
|
+
...options.headers
|
|
29726
|
+
}
|
|
29727
|
+
});
|
|
29728
|
+
var mediaGetGenerationCapabilities = (options) => (options?.client ?? client).get({
|
|
29729
|
+
security: [{
|
|
29730
|
+
key: "media-BearerAuth",
|
|
29731
|
+
scheme: "bearer",
|
|
29732
|
+
type: "http"
|
|
29733
|
+
}],
|
|
29734
|
+
url: "/media/v1/generation/capabilities",
|
|
29735
|
+
...options
|
|
29736
|
+
});
|
|
29737
|
+
var ontologyListTypes = (options) => (options?.client ?? client).get({
|
|
29738
|
+
security: [{
|
|
29739
|
+
key: "ontology-bearerAuth",
|
|
29740
|
+
scheme: "bearer",
|
|
29741
|
+
type: "http"
|
|
29742
|
+
}],
|
|
29743
|
+
url: "/ontology/v1/types",
|
|
29744
|
+
...options
|
|
29745
|
+
});
|
|
29746
|
+
var ontologyRegisterType = (options) => (options.client ?? client).post({
|
|
29747
|
+
security: [{
|
|
29748
|
+
key: "ontology-bearerAuth",
|
|
29749
|
+
scheme: "bearer",
|
|
29750
|
+
type: "http"
|
|
29751
|
+
}],
|
|
29752
|
+
url: "/ontology/v1/types",
|
|
29753
|
+
...options,
|
|
29754
|
+
headers: {
|
|
29755
|
+
"Content-Type": "application/json",
|
|
29756
|
+
...options.headers
|
|
29757
|
+
}
|
|
29758
|
+
});
|
|
29759
|
+
var ontologyRetrieveType = (options) => (options.client ?? client).get({
|
|
29760
|
+
security: [{
|
|
29761
|
+
key: "ontology-bearerAuth",
|
|
29762
|
+
scheme: "bearer",
|
|
29763
|
+
type: "http"
|
|
29764
|
+
}],
|
|
29765
|
+
url: "/ontology/v1/types/{name}",
|
|
29766
|
+
...options
|
|
29767
|
+
});
|
|
29768
|
+
var ontologyListNodes = (options) => (options?.client ?? client).get({
|
|
29769
|
+
security: [{
|
|
29770
|
+
key: "ontology-bearerAuth",
|
|
29771
|
+
scheme: "bearer",
|
|
29772
|
+
type: "http"
|
|
29773
|
+
}],
|
|
29774
|
+
url: "/ontology/v1/nodes",
|
|
29775
|
+
...options
|
|
29776
|
+
});
|
|
29777
|
+
var ontologyCreateNode = (options) => (options.client ?? client).post({
|
|
29778
|
+
security: [{
|
|
29779
|
+
key: "ontology-bearerAuth",
|
|
29780
|
+
scheme: "bearer",
|
|
29781
|
+
type: "http"
|
|
29782
|
+
}],
|
|
29783
|
+
url: "/ontology/v1/nodes",
|
|
29784
|
+
...options,
|
|
29785
|
+
headers: {
|
|
29786
|
+
"Content-Type": "application/json",
|
|
29787
|
+
...options.headers
|
|
29788
|
+
}
|
|
29789
|
+
});
|
|
29790
|
+
var ontologyRetrieveNode = (options) => (options.client ?? client).get({
|
|
29791
|
+
security: [{
|
|
29792
|
+
key: "ontology-bearerAuth",
|
|
29793
|
+
scheme: "bearer",
|
|
29794
|
+
type: "http"
|
|
29795
|
+
}],
|
|
29796
|
+
url: "/ontology/v1/nodes/{node_id}",
|
|
29797
|
+
...options
|
|
29798
|
+
});
|
|
29799
|
+
var ontologyUpdateNode = (options) => (options.client ?? client).patch({
|
|
29800
|
+
security: [{
|
|
29801
|
+
key: "ontology-bearerAuth",
|
|
29802
|
+
scheme: "bearer",
|
|
29803
|
+
type: "http"
|
|
29804
|
+
}],
|
|
29805
|
+
url: "/ontology/v1/nodes/{node_id}",
|
|
29806
|
+
...options,
|
|
29807
|
+
headers: {
|
|
29808
|
+
"Content-Type": "application/json",
|
|
29809
|
+
...options.headers
|
|
29810
|
+
}
|
|
29811
|
+
});
|
|
29812
|
+
var ontologyMergeNode = (options) => (options.client ?? client).post({
|
|
29813
|
+
security: [{
|
|
29814
|
+
key: "ontology-bearerAuth",
|
|
29815
|
+
scheme: "bearer",
|
|
29816
|
+
type: "http"
|
|
29817
|
+
}],
|
|
29818
|
+
url: "/ontology/v1/nodes/{node_id}/merge",
|
|
29819
|
+
...options,
|
|
29820
|
+
headers: {
|
|
29821
|
+
"Content-Type": "application/json",
|
|
29822
|
+
...options.headers
|
|
29823
|
+
}
|
|
29824
|
+
});
|
|
29825
|
+
var ontologyListRelations = (options) => (options?.client ?? client).get({
|
|
29826
|
+
security: [{
|
|
29827
|
+
key: "ontology-bearerAuth",
|
|
29828
|
+
scheme: "bearer",
|
|
29829
|
+
type: "http"
|
|
29830
|
+
}],
|
|
29831
|
+
url: "/ontology/v1/relations",
|
|
29832
|
+
...options
|
|
29833
|
+
});
|
|
29834
|
+
var ontologyCreateRelation = (options) => (options.client ?? client).post({
|
|
29835
|
+
security: [{
|
|
29836
|
+
key: "ontology-bearerAuth",
|
|
29837
|
+
scheme: "bearer",
|
|
29838
|
+
type: "http"
|
|
29839
|
+
}],
|
|
29840
|
+
url: "/ontology/v1/relations",
|
|
29841
|
+
...options,
|
|
29842
|
+
headers: {
|
|
29843
|
+
"Content-Type": "application/json",
|
|
29844
|
+
...options.headers
|
|
29845
|
+
}
|
|
29846
|
+
});
|
|
29847
|
+
var ontologyRetrieveRelation = (options) => (options.client ?? client).get({
|
|
29848
|
+
security: [{
|
|
29849
|
+
key: "ontology-bearerAuth",
|
|
29850
|
+
scheme: "bearer",
|
|
29851
|
+
type: "http"
|
|
29852
|
+
}],
|
|
29853
|
+
url: "/ontology/v1/relations/{relation_id}",
|
|
29854
|
+
...options
|
|
29855
|
+
});
|
|
29856
|
+
var ontologyInvalidateRelation = (options) => (options.client ?? client).post({
|
|
29857
|
+
security: [{
|
|
29858
|
+
key: "ontology-bearerAuth",
|
|
29859
|
+
scheme: "bearer",
|
|
29860
|
+
type: "http"
|
|
29861
|
+
}],
|
|
29862
|
+
url: "/ontology/v1/relations/{relation_id}/invalidate",
|
|
29863
|
+
...options,
|
|
29864
|
+
headers: {
|
|
29865
|
+
"Content-Type": "application/json",
|
|
29866
|
+
...options.headers
|
|
29867
|
+
}
|
|
29868
|
+
});
|
|
29869
|
+
var ontologyApplyChangeset = (options) => (options.client ?? client).post({
|
|
29870
|
+
security: [{
|
|
29871
|
+
key: "ontology-bearerAuth",
|
|
29872
|
+
scheme: "bearer",
|
|
29873
|
+
type: "http"
|
|
29874
|
+
}],
|
|
29875
|
+
url: "/ontology/v1/changesets",
|
|
29876
|
+
...options,
|
|
29877
|
+
headers: {
|
|
29878
|
+
"Content-Type": "application/json",
|
|
29879
|
+
...options.headers
|
|
29880
|
+
}
|
|
29881
|
+
});
|
|
29882
|
+
var ontologySearch = (options) => (options.client ?? client).post({
|
|
29883
|
+
security: [{
|
|
29884
|
+
key: "ontology-bearerAuth",
|
|
29885
|
+
scheme: "bearer",
|
|
29886
|
+
type: "http"
|
|
29887
|
+
}],
|
|
29888
|
+
url: "/ontology/v1/search",
|
|
29889
|
+
...options,
|
|
29890
|
+
headers: {
|
|
29891
|
+
"Content-Type": "application/json",
|
|
29892
|
+
...options.headers
|
|
29893
|
+
}
|
|
29894
|
+
});
|
|
27707
29895
|
var getSandboxV1Sandboxes = (options) => (options?.client ?? client).get({
|
|
27708
29896
|
querySerializer: { parameters: { state: { array: { explode: false } } } },
|
|
27709
29897
|
security: [
|
|
@@ -29581,6 +31769,9 @@ function createAgent(transport) {
|
|
|
29581
31769
|
create: bind(transport, computersCreate),
|
|
29582
31770
|
delete: bind(transport, computersDelete),
|
|
29583
31771
|
files: {
|
|
31772
|
+
convert: {
|
|
31773
|
+
create: bind(transport, computersFilesConvert)
|
|
31774
|
+
},
|
|
29584
31775
|
list: bind(transport, computersFilesList),
|
|
29585
31776
|
retrieveContent: bind(transport, computersFilesContent)
|
|
29586
31777
|
},
|
|
@@ -30028,6 +32219,9 @@ function createCut(transport) {
|
|
|
30028
32219
|
media: {
|
|
30029
32220
|
import: bind(transport, cutImportMedia)
|
|
30030
32221
|
},
|
|
32222
|
+
renders: {
|
|
32223
|
+
create: bind(transport, cutCreateRender)
|
|
32224
|
+
},
|
|
30031
32225
|
retrieve: bind(transport, cutRetrieveProject),
|
|
30032
32226
|
retrieveState: bind(transport, cutRetrieveState),
|
|
30033
32227
|
retrieveTimeline: bind(transport, cutRetrieveTimeline),
|
|
@@ -30038,6 +32232,9 @@ function createCut(transport) {
|
|
|
30038
32232
|
list: bind(transport, cutListVersions)
|
|
30039
32233
|
}
|
|
30040
32234
|
},
|
|
32235
|
+
renders: {
|
|
32236
|
+
retrieve: bind(transport, cutRetrieveRender)
|
|
32237
|
+
},
|
|
30041
32238
|
versions: {
|
|
30042
32239
|
restore: bind(transport, cutRestoreVersion)
|
|
30043
32240
|
}
|
|
@@ -30080,6 +32277,51 @@ function createDatabase(transport) {
|
|
|
30080
32277
|
}
|
|
30081
32278
|
};
|
|
30082
32279
|
}
|
|
32280
|
+
function createDevops(transport) {
|
|
32281
|
+
return {
|
|
32282
|
+
projects: {
|
|
32283
|
+
retrieveTestCatalog: bind(transport, devopsTestCatalogGet),
|
|
32284
|
+
testCases: {
|
|
32285
|
+
list: bind(transport, devopsTestCasesList)
|
|
32286
|
+
},
|
|
32287
|
+
testPlans: {
|
|
32288
|
+
create: bind(transport, devopsTestPlansCreate),
|
|
32289
|
+
list: bind(transport, devopsTestPlansList)
|
|
32290
|
+
},
|
|
32291
|
+
testReports: {
|
|
32292
|
+
create: bind(transport, devopsTestReportsUpload)
|
|
32293
|
+
},
|
|
32294
|
+
testRuns: {
|
|
32295
|
+
create: bind(transport, devopsTestRunsCreate),
|
|
32296
|
+
list: bind(transport, devopsTestRunsList)
|
|
32297
|
+
},
|
|
32298
|
+
testSuites: {
|
|
32299
|
+
list: bind(transport, devopsTestSuitesList)
|
|
32300
|
+
}
|
|
32301
|
+
},
|
|
32302
|
+
testCases: {
|
|
32303
|
+
retrieve: bind(transport, devopsTestCasesGet)
|
|
32304
|
+
},
|
|
32305
|
+
testPlans: {
|
|
32306
|
+
delete: bind(transport, devopsTestPlansDelete),
|
|
32307
|
+
pause: bind(transport, devopsTestPlansPause),
|
|
32308
|
+
resume: bind(transport, devopsTestPlansResume),
|
|
32309
|
+
retrieve: bind(transport, devopsTestPlansGet),
|
|
32310
|
+
update: bind(transport, devopsTestPlansUpdate)
|
|
32311
|
+
},
|
|
32312
|
+
testRuns: {
|
|
32313
|
+
cancel: bind(transport, devopsTestRunsCancel),
|
|
32314
|
+
executions: {
|
|
32315
|
+
list: bind(transport, devopsTestExecutionsList),
|
|
32316
|
+
retrieve: bind(transport, devopsTestExecutionsGet)
|
|
32317
|
+
},
|
|
32318
|
+
retrieve: bind(transport, devopsTestRunsGet)
|
|
32319
|
+
},
|
|
32320
|
+
testSuites: {
|
|
32321
|
+
retrieve: bind(transport, devopsTestSuitesGet)
|
|
32322
|
+
}
|
|
32323
|
+
};
|
|
32324
|
+
}
|
|
30083
32325
|
function createFile(transport) {
|
|
30084
32326
|
return {
|
|
30085
32327
|
files: {
|
|
@@ -30102,7 +32344,8 @@ function createFile(transport) {
|
|
|
30102
32344
|
createSigned: bind(transport, fileCreateSignedUpload),
|
|
30103
32345
|
parts: {
|
|
30104
32346
|
create: bind(transport, (options) => fileAddUploadPart({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } }))
|
|
30105
|
-
}
|
|
32347
|
+
},
|
|
32348
|
+
retrieve: bind(transport, fileRetrieveUpload)
|
|
30106
32349
|
}
|
|
30107
32350
|
};
|
|
30108
32351
|
}
|
|
@@ -30154,6 +32397,11 @@ function createKnowledge(transport) {
|
|
|
30154
32397
|
}
|
|
30155
32398
|
function createMedia(transport) {
|
|
30156
32399
|
return {
|
|
32400
|
+
generation: {
|
|
32401
|
+
capabilities: {
|
|
32402
|
+
list: bind(transport, mediaGetGenerationCapabilities)
|
|
32403
|
+
}
|
|
32404
|
+
},
|
|
30157
32405
|
libraries: {
|
|
30158
32406
|
assets: {
|
|
30159
32407
|
batch: bind(transport, mediaBatchAssets),
|
|
@@ -30190,7 +32438,17 @@ function createMedia(transport) {
|
|
|
30190
32438
|
folders: {
|
|
30191
32439
|
list: bind(transport, mediaListFolders)
|
|
30192
32440
|
},
|
|
32441
|
+
generations: {
|
|
32442
|
+
create: bind(transport, mediaCreateGeneration)
|
|
32443
|
+
},
|
|
30193
32444
|
jobs: {
|
|
32445
|
+
cancel: bind(transport, mediaCancelJob),
|
|
32446
|
+
list: bindPage(transport, mediaListJobs),
|
|
32447
|
+
outputs: {
|
|
32448
|
+
save: {
|
|
32449
|
+
create: bind(transport, mediaSaveGenerationOutput)
|
|
32450
|
+
}
|
|
32451
|
+
},
|
|
30194
32452
|
retrieve: bind(transport, mediaGetJob)
|
|
30195
32453
|
},
|
|
30196
32454
|
list: bindPage(transport, mediaListLibraries),
|
|
@@ -30315,6 +32573,38 @@ function createModel(transport) {
|
|
|
30315
32573
|
}
|
|
30316
32574
|
};
|
|
30317
32575
|
}
|
|
32576
|
+
function createOntology(transport) {
|
|
32577
|
+
return {
|
|
32578
|
+
changesets: {
|
|
32579
|
+
create: bind(transport, ontologyApplyChangeset)
|
|
32580
|
+
},
|
|
32581
|
+
nodes: {
|
|
32582
|
+
create: bind(transport, ontologyCreateNode),
|
|
32583
|
+
list: bindPage(transport, ontologyListNodes),
|
|
32584
|
+
merge: {
|
|
32585
|
+
create: bind(transport, ontologyMergeNode)
|
|
32586
|
+
},
|
|
32587
|
+
retrieve: bind(transport, ontologyRetrieveNode),
|
|
32588
|
+
update: bind(transport, ontologyUpdateNode)
|
|
32589
|
+
},
|
|
32590
|
+
relations: {
|
|
32591
|
+
create: bind(transport, ontologyCreateRelation),
|
|
32592
|
+
invalidate: {
|
|
32593
|
+
create: bind(transport, ontologyInvalidateRelation)
|
|
32594
|
+
},
|
|
32595
|
+
list: bindPage(transport, ontologyListRelations),
|
|
32596
|
+
retrieve: bind(transport, ontologyRetrieveRelation)
|
|
32597
|
+
},
|
|
32598
|
+
search: {
|
|
32599
|
+
create: bind(transport, ontologySearch)
|
|
32600
|
+
},
|
|
32601
|
+
types: {
|
|
32602
|
+
create: bind(transport, ontologyRegisterType),
|
|
32603
|
+
list: bind(transport, ontologyListTypes),
|
|
32604
|
+
retrieve: bind(transport, ontologyRetrieveType)
|
|
32605
|
+
}
|
|
32606
|
+
};
|
|
32607
|
+
}
|
|
30318
32608
|
function createOrganization(transport) {
|
|
30319
32609
|
return {
|
|
30320
32610
|
charges: {
|
|
@@ -30576,11 +32866,13 @@ var resourceFactories = {
|
|
|
30576
32866
|
crm: createCrm,
|
|
30577
32867
|
cut: createCut,
|
|
30578
32868
|
database: createDatabase,
|
|
32869
|
+
devops: createDevops,
|
|
30579
32870
|
file: createFile,
|
|
30580
32871
|
knowledge: createKnowledge,
|
|
30581
32872
|
media: createMedia,
|
|
30582
32873
|
meta: createMeta,
|
|
30583
32874
|
model: createModel,
|
|
32875
|
+
ontology: createOntology,
|
|
30584
32876
|
organization: createOrganization,
|
|
30585
32877
|
sandbox: createSandbox,
|
|
30586
32878
|
search: createSearch,
|
|
@@ -31654,6 +33946,26 @@ async function prepareMultipart(op, opts) {
|
|
|
31654
33946
|
opts.body = body;
|
|
31655
33947
|
}
|
|
31656
33948
|
|
|
33949
|
+
// src/core/pagination.ts
|
|
33950
|
+
var PAGE_TOKENS = /^(page_?token|next_?page_?token)$/i;
|
|
33951
|
+
function pageTokenField(op) {
|
|
33952
|
+
return op.query.find((field) => PAGE_TOKENS.test(field.name));
|
|
33953
|
+
}
|
|
33954
|
+
function nextPageToken(result) {
|
|
33955
|
+
const value = result;
|
|
33956
|
+
const token = value?.next_page_token ?? value?.nextPageToken ?? value?.next_cursor;
|
|
33957
|
+
return typeof token === "string" && token ? token : undefined;
|
|
33958
|
+
}
|
|
33959
|
+
function pageOf(result) {
|
|
33960
|
+
const value = result;
|
|
33961
|
+
const arrays = value && typeof value === "object" ? Object.values(value).filter(Array.isArray) : [];
|
|
33962
|
+
const data = Array.isArray(value?.data) ? value.data : Array.isArray(value?.items) ? value.items : arrays.length === 1 ? arrays[0] : undefined;
|
|
33963
|
+
if (!Array.isArray(data))
|
|
33964
|
+
return;
|
|
33965
|
+
const token = nextPageToken(result);
|
|
33966
|
+
return { items: data, ...token ? { token } : {} };
|
|
33967
|
+
}
|
|
33968
|
+
|
|
31657
33969
|
// src/core/bind-args.ts
|
|
31658
33970
|
var globalOptions = [
|
|
31659
33971
|
{ name: "org", type: "string" },
|
|
@@ -31869,7 +34181,7 @@ function bindArgs(parsed, op, data) {
|
|
|
31869
34181
|
(opts.query ??= {})[key] ??= convert(String(globals[name]), { name, type: field.type, enum: field.enum });
|
|
31870
34182
|
}
|
|
31871
34183
|
}
|
|
31872
|
-
if (globals.all && !op.pagination)
|
|
34184
|
+
if (globals.all && !op.pagination && !pageTokenField(op))
|
|
31873
34185
|
throw new UsageError("--all requires a paginated operation");
|
|
31874
34186
|
for (const p of op.pathParams)
|
|
31875
34187
|
if (p !== target && opts.path?.[p.sdkName] === undefined)
|
|
@@ -31895,8 +34207,8 @@ function bindArgs(parsed, op, data) {
|
|
|
31895
34207
|
}
|
|
31896
34208
|
|
|
31897
34209
|
// src/core/help.ts
|
|
31898
|
-
function describeOption(s) {
|
|
31899
|
-
return `--${s.name}${s.type === "boolean" ? " [true|false]" : ` <${s.type}>`}${s.repeated ? " (repeatable)" : ""}${
|
|
34210
|
+
function describeOption(s, required = s.required) {
|
|
34211
|
+
return `--${s.name}${s.type === "boolean" ? " [true|false]" : ` <${s.type}>`}${s.repeated ? " (repeatable)" : ""}${required ? " (required)" : ""}${s.enum ? ` [${s.enum.join(" | ")}]` : ""}${s.description ? ` — ${s.description.replace(/\s+/g, " ")}` : ""}`;
|
|
31900
34212
|
}
|
|
31901
34213
|
function example(command) {
|
|
31902
34214
|
const target = targetParam(command.op);
|
|
@@ -31912,18 +34224,22 @@ function example(command) {
|
|
|
31912
34224
|
args.push("--yes");
|
|
31913
34225
|
return args.join(" ");
|
|
31914
34226
|
}
|
|
34227
|
+
function fieldRequired(op, field, location) {
|
|
34228
|
+
return Boolean(field.required) && (location === "path" || location === "query" || Boolean(op.body?.required));
|
|
34229
|
+
}
|
|
31915
34230
|
function help(commands, prefix, command) {
|
|
31916
34231
|
if (command) {
|
|
31917
34232
|
const target = targetParam(command.op);
|
|
34233
|
+
const parents = operationOptions(command.op).filter((s) => s.location === "path" && s.required).map((s) => ` --${s.name} <${s.field?.name ?? s.sdkName}>`).join("");
|
|
31918
34234
|
return [
|
|
31919
|
-
`praxis ${command.words.join(" ")}${target ? ` <${target.sdkName}>` : ""} [options]`,
|
|
34235
|
+
`praxis ${command.words.join(" ")}${parents}${target ? ` <${target.sdkName}>` : ""} [options]`,
|
|
31920
34236
|
`SDK: ${command.op.resource}.${command.alias ?? command.op.method}`,
|
|
31921
34237
|
`${command.op.http} ${command.op.path}`,
|
|
31922
34238
|
...target ? [`Position: <${target.sdkName}>${target.type ? ` <${target.type}>` : ""} (required target ID)`] : [],
|
|
31923
34239
|
"",
|
|
31924
34240
|
"Options:",
|
|
31925
34241
|
...target?.description ? [` <${target.sdkName}> — ${target.description.replace(/\s+/g, " ")}`] : [],
|
|
31926
|
-
...[...operationOptions(command.op), ...bodyDataOption(command.op), ...globalOptions].map((s) => ` ${describeOption(s)}`),
|
|
34242
|
+
...[...operationOptions(command.op), ...bodyDataOption(command.op), ...globalOptions].map((s) => ` ${describeOption(s, s.required && fieldRequired(command.op, s, s.location ?? "query"))}`),
|
|
31927
34243
|
...command.op.body?.fields.filter((f) => !operationOptions(command.op).some((s) => s.location === "body" && s.field === f) && (f.type === "object" || f.type === "array" && !["string", "number", "integer", "boolean"].includes(f.itemType ?? ""))).map((f) => ` --data: ${f.name} (${f.type}${f.required ? ", required" : ""})`) ?? [],
|
|
31928
34244
|
" -h is an alias of --help",
|
|
31929
34245
|
"PRAXIS_ENV=develop|production (default: develop); no --env option.",
|
|
@@ -33291,9 +35607,11 @@ function renderHuman(result, ctx) {
|
|
|
33291
35607
|
const details = result.details !== undefined ? JSON.stringify(result.details) : undefined;
|
|
33292
35608
|
const detailsLine = details !== undefined ? ` details ${details.length > 2000 ? details.slice(0, 1999) + "…" : details}
|
|
33293
35609
|
` : "";
|
|
35610
|
+
const problemLine = problemLines(result.problem).map((line) => ` ${plain(line)}
|
|
35611
|
+
`).join("");
|
|
33294
35612
|
return { stderr: err.red(`✗ ${plain(result.message)}`) + `
|
|
33295
35613
|
` + err.dim(` code ${plain(result.code)}${result.status !== undefined ? ` · ${result.status}` : ""} · env ${plain(result.env)}${result.request_id ? ` · request ${plain(result.request_id)}` : ""}`) + `
|
|
33296
|
-
` + detailsLine + (result.hint ? ` → ${plain(result.hint)}
|
|
35614
|
+
` + detailsLine + problemLine + (result.hint ? ` → ${plain(result.hint)}
|
|
33297
35615
|
` : "") };
|
|
33298
35616
|
}
|
|
33299
35617
|
case "list":
|
|
@@ -33381,8 +35699,33 @@ ${usage ? `usage: ${JSON.stringify(usage)}
|
|
|
33381
35699
|
}
|
|
33382
35700
|
|
|
33383
35701
|
// src/output/render.ts
|
|
35702
|
+
var PROBLEM_HINTS = ["hint", "errors", "violations", "title", "type"];
|
|
35703
|
+
function serverProblem(raw) {
|
|
35704
|
+
const value = record(raw);
|
|
35705
|
+
const problem = {};
|
|
35706
|
+
for (const member of ["code", "detail", ...PROBLEM_HINTS, "status"]) {
|
|
35707
|
+
const entry = value[member];
|
|
35708
|
+
if (entry !== undefined && entry !== null)
|
|
35709
|
+
problem[member] = entry;
|
|
35710
|
+
}
|
|
35711
|
+
const adds = PROBLEM_HINTS.some((member) => Array.isArray(problem[member]) ? problem[member].length > 0 : problem[member] !== undefined);
|
|
35712
|
+
return adds ? problem : undefined;
|
|
35713
|
+
}
|
|
35714
|
+
function problemLines(problem) {
|
|
35715
|
+
const lines = [];
|
|
35716
|
+
for (const group of [problem?.errors, problem?.violations]) {
|
|
35717
|
+
for (const item of Array.isArray(group) ? group : []) {
|
|
35718
|
+
const entry = record(item);
|
|
35719
|
+
const where = scalar(entry.pointer ?? entry.field);
|
|
35720
|
+
const detail = scalar(entry.detail ?? entry.message ?? entry.reason);
|
|
35721
|
+
if (where || detail)
|
|
35722
|
+
lines.push(`${where ? `${where}: ` : ""}${detail}`);
|
|
35723
|
+
}
|
|
35724
|
+
}
|
|
35725
|
+
return lines;
|
|
35726
|
+
}
|
|
33384
35727
|
function errorJSON(result, ctx) {
|
|
33385
|
-
return JSON.stringify({ error: { code: result.code, ...result.details !== undefined ? { details: result.details } : {}, message: result.message, hint: result.hint ?? null, env: result.env, command: ctx.command ?? null, status: result.status ?? null, request_id: result.request_id ?? null, ...result.credential_source ? { credential_source: result.credential_source } : {} } }) + `
|
|
35728
|
+
return JSON.stringify({ error: { code: result.code, ...result.details !== undefined ? { details: result.details } : {}, message: result.message, hint: result.hint ?? null, env: result.env, command: ctx.command ?? null, status: result.status ?? null, request_id: result.request_id ?? null, ...result.problem !== undefined ? { problem: result.problem } : {}, ...result.credential_source ? { credential_source: result.credential_source } : {} } }) + `
|
|
33386
35729
|
`;
|
|
33387
35730
|
}
|
|
33388
35731
|
function render(result, ctx) {
|
|
@@ -33538,6 +35881,8 @@ function errorInput(error, ctx) {
|
|
|
33538
35881
|
const raw = record(sdk?.raw), nested = record(raw.error);
|
|
33539
35882
|
const candidate = nested.details ?? raw.details;
|
|
33540
35883
|
const details = candidate !== null && typeof candidate === "object" && !Array.isArray(candidate) ? candidate : undefined;
|
|
35884
|
+
const problem = serverProblem(Object.keys(nested).length ? nested : raw);
|
|
35885
|
+
const serverText = (value) => typeof value === "string" && value.trim() ? value : undefined;
|
|
33541
35886
|
let message = error instanceof Error ? error.message : "Unexpected error";
|
|
33542
35887
|
const prefix = message.match(/^([A-Z][A-Z0-9_]+):\s*/)?.[1];
|
|
33543
35888
|
const code = error instanceof UsageError ? error.code : businessCode(raw.code) ?? businessCode(nested.code) ?? businessCode(raw.error_code) ?? prefix ?? businessCode(sdk?.code) ?? (sdk?.status ? `HTTP_${sdk.status}` : sdk ? "API_ERROR" : "RUNTIME_ERROR");
|
|
@@ -33549,11 +35894,14 @@ function errorInput(error, ctx) {
|
|
|
33549
35894
|
if (stripped)
|
|
33550
35895
|
message = `${humanize(code)}${message ? `: ${message}` : ""}`;
|
|
33551
35896
|
const status = sdk?.status, request_id = sdk?.requestId;
|
|
35897
|
+
message = serverText(problem?.detail) ?? serverText(problem?.title) ?? message;
|
|
33552
35898
|
const authFailure = status === 401 || ["NOT_LOGGED_IN", "UNAUTHENTICATED", "TOKEN_REVOKED", "LOGIN_FAILED"].includes(code);
|
|
33553
35899
|
const source = ctx.credentialSource ?? "login";
|
|
33554
35900
|
let hint = genericHint;
|
|
33555
35901
|
if (error instanceof UsageError)
|
|
33556
35902
|
hint = error.hint;
|
|
35903
|
+
else if (serverText(problem?.hint))
|
|
35904
|
+
hint = serverText(problem?.hint);
|
|
33557
35905
|
else if (authFailure)
|
|
33558
35906
|
hint = authHint(source);
|
|
33559
35907
|
else if (status === 404)
|
|
@@ -33564,7 +35912,7 @@ function errorInput(error, ctx) {
|
|
|
33564
35912
|
hint = "Rate limited; retry later.";
|
|
33565
35913
|
else if (status !== undefined && status >= 500)
|
|
33566
35914
|
hint = `Server error; retry later.${request_id ? ` Request id: ${request_id}.` : ""}`;
|
|
33567
|
-
return { kind: "error", code, message, hint, ...details !== undefined ? { details } : {}, env: ctx.env, ...authFailure ? { credential_source: source } : {}, ...status !== undefined ? { status } : {}, ...request_id ? { request_id } : {} };
|
|
35915
|
+
return { kind: "error", code, message, hint, ...details !== undefined ? { details } : {}, ...problem !== undefined ? { problem } : {}, env: ctx.env, ...authFailure ? { credential_source: source } : {}, ...status !== undefined ? { status } : {}, ...request_id ? { request_id } : {} };
|
|
33568
35916
|
}
|
|
33569
35917
|
|
|
33570
35918
|
// src/output/progress.ts
|
|
@@ -33594,7 +35942,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
|
|
|
33594
35942
|
}
|
|
33595
35943
|
|
|
33596
35944
|
// src/main.ts
|
|
33597
|
-
var version = "0.2.1-dev.
|
|
35945
|
+
var version = "0.2.1-dev.da8587f";
|
|
33598
35946
|
var commands = commandTree(operations);
|
|
33599
35947
|
var manual = [...workflows.map((w) => w.words), [API_WORD]];
|
|
33600
35948
|
function route(argv) {
|
|
@@ -33812,7 +36160,7 @@ Examples:
|
|
|
33812
36160
|
let owner = client2;
|
|
33813
36161
|
for (const part of op.resource.split("."))
|
|
33814
36162
|
owner = owner[part];
|
|
33815
|
-
|
|
36163
|
+
let result = await owner[op.method](opts);
|
|
33816
36164
|
const name2 = `${op.resource}.${op.method}`;
|
|
33817
36165
|
const list = (items) => {
|
|
33818
36166
|
const view = clientList(items, op, flags.limit, ctx.mode);
|
|
@@ -33826,7 +36174,21 @@ Examples:
|
|
|
33826
36174
|
const cursor = result instanceof Page ? result.next_cursor : record(result).next_cursor ?? record(result).nextToken;
|
|
33827
36175
|
if (typeof cursor === "string" && cursor)
|
|
33828
36176
|
ctx.nextCommand = nextPageCommand(selected.command, parsed, cursor);
|
|
33829
|
-
|
|
36177
|
+
const pageToken = pageTokenField(op), token = pageToken?.sdkName ?? pageToken?.name;
|
|
36178
|
+
const firstPage = flags.all && !(result instanceof Page) && token ? pageOf(result) : undefined;
|
|
36179
|
+
if (flags.all && !(result instanceof Page) && token && !firstPage)
|
|
36180
|
+
throw new UsageError(`--all cannot find the list in ${op.resource}.${op.method}'s response; page with --${token.replace(/_/g, "-")} instead`);
|
|
36181
|
+
if (firstPage) {
|
|
36182
|
+
const items = [...firstPage.items];
|
|
36183
|
+
const seen = new Set;
|
|
36184
|
+
for (let next = firstPage.token;next && !seen.has(next); next = pageOf(result)?.token) {
|
|
36185
|
+
seen.add(next);
|
|
36186
|
+
result = await owner[op.method]({ ...opts, query: { ...opts.query, [token]: next } });
|
|
36187
|
+
items.push(...pageOf(result)?.items ?? []);
|
|
36188
|
+
}
|
|
36189
|
+
ctx.nextCommand = undefined;
|
|
36190
|
+
emit({ kind: "list", ...list(items), ...ctx.mode === "json" ? { raw: { data: items, next_page_token: null } } : {}, nextCursor: null, op: name2 });
|
|
36191
|
+
} else if (result instanceof Page) {
|
|
33830
36192
|
if (flags.all) {
|
|
33831
36193
|
const items = [];
|
|
33832
36194
|
for await (const item of result)
|
|
@@ -33922,7 +36284,7 @@ Examples:
|
|
|
33922
36284
|
}
|
|
33923
36285
|
}
|
|
33924
36286
|
if (true)
|
|
33925
|
-
process.
|
|
36287
|
+
process.exitCode = await main(process.argv.slice(2));
|
|
33926
36288
|
export {
|
|
33927
36289
|
main
|
|
33928
36290
|
};
|