@deepraxis/cli 0.2.1-dev.71b291b → 0.2.1-dev.73a8792
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 +39 -2
- package/README.md +15 -0
- package/dist/praxis.js +2343 -44
- 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
|
}
|
|
@@ -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[];\nListAnimations(): { id: string; version: number; phase: "in" | "out" | "loop"; target: "any" | "text"; name: string; description: string; defaultDuration: number; params: { name: string; type: string; values?: string[]; default?: string | number; min?: number; max?: number; description: string }[] }[];\nListFonts(): { family: string; weights: number[]; scripts: ("latin"|"cjk")[]; source: "bundled"|"catalog" }[];\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| ListAnimations | Discover animation presets. Each entry has id, version, phase (`in`, `out`, `loop`), target (`any`, `text`), name, description, defaultDuration (seconds), and params (name, type, values/default/min/max/description as applicable). A slot use is `{preset, duration?, ...params}`; duration is seconds. |\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 catalog defaults. Unknown kinds and invalid parameters return INVALID_TRANSITION_PARAM with available parameters. Effects: dissolve; dip color black/white default black; push and wipe direction left/right/up/down default left; wipe softness 0–1 default 0; iris centerX/centerY 0–1 default 0.5; blinds integer count 2–64 default 8 and orientation vertical/horizontal default vertical; blur radius 0–100 pixels at 1080-pixel frame height default 24; zoom direction in/out default in, amount 0.1–3 default 1, blur 0–1 default 0.5; clock direction clockwise/counterclockwise default clockwise, startAngle 0–360 degrees default 0 (twelve o\'clock), softness 0–1 default 0; flash color white/black default white, intensity 0–1 default 1. Zoom blur uses up to eight radial samples per shot and is slower on server rendering. 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, animation, transitionIn, transitionOut |\n| image | media, length | transform, fit, animate, animation, transitionIn, transitionOut |\n| text | text, length | style, transform, reveal, animate, animation, transitionIn, transitionOut |\n| color | color, length | transform, fill, animate, animation, transitionIn, transitionOut |\n| shape | shape, length, width, height, fill | radius, stroke, transform, animate, animation, 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, fill, stroke, strokes, shadows, glow, background, align, maxWidth, position, margin}`. fill accepts a color or linear/radial gradient across the entire text bounding box. strokes draw outside to inside; at most 4, width 0–40. shadows accepts at most 4 `{color,x,y,blur}` entries; blur is 0–100. glow is `{color,radius,strength}` with radius 0–100 and strength 0–1. All dimensions use pixels at 1080 frame height and scale with the text. Glow and large shadow blur increase render time. Invalid colors or ranges return actionable INVALID_STYLE errors. `ListFonts()` discovers family, available weights, scripts and bundled/catalog source. Text and captions share the style fields; caption style additionally supports highlightColor and maxLines: 2. |\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| animation | `{in?: AnimationUse, out?: AnimationUse, loop?: AnimationUse}` on visual clips. Each use is `{preset: string, duration?: number, ...params}`; duration and parameter units follow `ListAnimations()`. Presets replace existing animate and reveal when applied. Update accepts `animation: null` to clear the preset and its generated effects. |\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, animation, fill, stroke, shape, width, height, radius, transitionIn, transitionOut. Values and units match Insert. Set animation to null to clear the preset; set animate or reveal to null to remove that effect. Applying a preset replaces existing animate/reveal. Do not set animation together with animate or reveal in one Insert/Update call. Omit a field to preserve it.\n\n#### Animation presets\n\nDiscover the catalog with `ListAnimations()`. Its entries contain id, version, phase (`in`, `out`, `loop`), target (`any` or `text`), name, description, defaultDuration in seconds, and params. Slots may combine one in, one out and one loop preset. A loop runs only in the interval between in and out; if the same property is animated by multiple slots, loop occupies only that middle interval. Text-target presets are entrances. Their duration controls the rhythm per character/word/line, not the total reveal time. Out and loop presets apply to the whole clip, not per text unit.\n\nPresets replace the clip\'s existing animate and reveal when applied. The source preset is retained, so changing clip length or transform automatically regenerates its keyframes/reveal. If a clip becomes shorter, in/out durations shrink proportionally; when it grows, the requested durations are restored. Split keeps in on the left, out on the right, and loop on both. Writing animate or reveal directly detaches the preset; setting animation to null clears both source and generated effects. Insert/Update reject a call that supplies animation together with animate or reveal.\n\nErrors: UNKNOWN_ANIMATION (unknown preset), INVALID_ANIMATION_PARAM (invalid slot/parameter or frame/keyframe limit), ANIMATION_TOO_LONG (in+out exceed clip length), ANIMATION_TARGET_MISMATCH (text-only preset on a non-text or preset on non-visual clip), ANIMATION_PHASE_MISMATCH (preset in the wrong slot). Each animated property is limited to 600 keyframes; loop duration must be at least 4 frames. `ANIMATION_TOO_LONG` is avoided during later length changes by proportional fitting.\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,696 @@ 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. Nothing has to exist first: a first upload from CI creates the run it reports on (executor external) and catalogues the cases the report names, so there is no setup call before the first result. When the report already belongs to a run, pass ref and the upload joins it; the run's counts and verdict are recomputed from the report. Uploading the same reportId again is idempotent and counts once, so a retry after a timeout is safe — and a reported case is catalogued once, however many reports carry it. The report's bytes are kept as a file (the file field of the answer) rather than in the results database, so the original document stays retrievable.",
|
|
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
|
+
name: "executor",
|
|
12031
|
+
type: "string",
|
|
12032
|
+
enum: [
|
|
12033
|
+
"cloud",
|
|
12034
|
+
"external"
|
|
12035
|
+
],
|
|
12036
|
+
required: false,
|
|
12037
|
+
description: "Who carries the run out. cloud, the default, runs the selected cases in Praxis at the commit; external creates a run that waits for your own CI to upload a report with test-reports."
|
|
12038
|
+
},
|
|
12039
|
+
{
|
|
12040
|
+
name: "requestId",
|
|
12041
|
+
type: "string",
|
|
12042
|
+
required: false,
|
|
12043
|
+
description: "A key you choose to make creating this run idempotent: repeating the call with the same requestId returns the run it created instead of starting another, so a retry after a timeout is safe."
|
|
12044
|
+
}
|
|
12045
|
+
]
|
|
12046
|
+
}
|
|
12047
|
+
},
|
|
12048
|
+
{
|
|
12049
|
+
resource: "devops.projects.testSuites",
|
|
12050
|
+
method: "list",
|
|
12051
|
+
summary: "List test suites",
|
|
12052
|
+
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.",
|
|
12053
|
+
http: "GET",
|
|
12054
|
+
path: "/devops/v1/projects/{project}/test-suites",
|
|
12055
|
+
streaming: "no",
|
|
12056
|
+
pagination: false,
|
|
12057
|
+
pathParams: [
|
|
12058
|
+
{
|
|
12059
|
+
name: "project",
|
|
12060
|
+
sdkName: "project",
|
|
12061
|
+
description: "Identifies the project whose data you are reading, from the project list or create answer."
|
|
12062
|
+
}
|
|
12063
|
+
],
|
|
12064
|
+
query: [
|
|
12065
|
+
{
|
|
12066
|
+
name: "pageSize",
|
|
12067
|
+
type: "integer",
|
|
12068
|
+
required: false,
|
|
12069
|
+
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."
|
|
12070
|
+
},
|
|
12071
|
+
{
|
|
12072
|
+
name: "pageToken",
|
|
12073
|
+
type: "string",
|
|
12074
|
+
required: false,
|
|
12075
|
+
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
12076
|
+
},
|
|
12077
|
+
{
|
|
12078
|
+
name: "orderBy",
|
|
12079
|
+
type: "string",
|
|
12080
|
+
required: false,
|
|
12081
|
+
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."
|
|
12082
|
+
}
|
|
12083
|
+
]
|
|
12084
|
+
},
|
|
12085
|
+
{
|
|
12086
|
+
resource: "devops.testCases",
|
|
12087
|
+
method: "retrieve",
|
|
12088
|
+
summary: "Retrieve a test case",
|
|
12089
|
+
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.",
|
|
12090
|
+
http: "GET",
|
|
12091
|
+
path: "/devops/v1/test-cases/{id}",
|
|
12092
|
+
streaming: "no",
|
|
12093
|
+
pagination: false,
|
|
12094
|
+
pathParams: [
|
|
12095
|
+
{
|
|
12096
|
+
name: "id",
|
|
12097
|
+
sdkName: "id",
|
|
12098
|
+
description: "The case identifier returned by a case list, or an older id listed in that case's aliases."
|
|
12099
|
+
}
|
|
12100
|
+
],
|
|
12101
|
+
query: []
|
|
12102
|
+
},
|
|
12103
|
+
{
|
|
12104
|
+
resource: "devops.testPlans",
|
|
12105
|
+
method: "delete",
|
|
12106
|
+
summary: "Delete a test plan",
|
|
12107
|
+
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.",
|
|
12108
|
+
http: "DELETE",
|
|
12109
|
+
path: "/devops/v1/test-plans/{id}",
|
|
12110
|
+
streaming: "no",
|
|
12111
|
+
pagination: false,
|
|
12112
|
+
pathParams: [
|
|
12113
|
+
{
|
|
12114
|
+
name: "id",
|
|
12115
|
+
sdkName: "id",
|
|
12116
|
+
description: "The plan identifier returned by a plan list or create answer."
|
|
12117
|
+
}
|
|
12118
|
+
],
|
|
12119
|
+
query: []
|
|
12120
|
+
},
|
|
12121
|
+
{
|
|
12122
|
+
resource: "devops.testPlans",
|
|
12123
|
+
method: "retrieve",
|
|
12124
|
+
summary: "Retrieve a test plan",
|
|
12125
|
+
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.",
|
|
12126
|
+
http: "GET",
|
|
12127
|
+
path: "/devops/v1/test-plans/{id}",
|
|
12128
|
+
streaming: "no",
|
|
12129
|
+
pagination: false,
|
|
12130
|
+
pathParams: [
|
|
12131
|
+
{
|
|
12132
|
+
name: "id",
|
|
12133
|
+
sdkName: "id",
|
|
12134
|
+
description: "The plan identifier returned by a plan list or create answer."
|
|
12135
|
+
}
|
|
12136
|
+
],
|
|
12137
|
+
query: []
|
|
12138
|
+
},
|
|
12139
|
+
{
|
|
12140
|
+
resource: "devops.testPlans",
|
|
12141
|
+
method: "update",
|
|
12142
|
+
summary: "Update a test plan",
|
|
12143
|
+
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.",
|
|
12144
|
+
http: "PATCH",
|
|
12145
|
+
path: "/devops/v1/test-plans/{id}",
|
|
12146
|
+
streaming: "no",
|
|
12147
|
+
pagination: false,
|
|
12148
|
+
pathParams: [
|
|
12149
|
+
{
|
|
12150
|
+
name: "id",
|
|
12151
|
+
sdkName: "id",
|
|
12152
|
+
description: "The plan identifier returned by a plan list or create answer."
|
|
12153
|
+
}
|
|
12154
|
+
],
|
|
12155
|
+
query: [],
|
|
12156
|
+
body: {
|
|
12157
|
+
required: true,
|
|
12158
|
+
fields: [
|
|
12159
|
+
{
|
|
12160
|
+
name: "plan",
|
|
12161
|
+
type: "object",
|
|
12162
|
+
required: true,
|
|
12163
|
+
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."
|
|
12164
|
+
},
|
|
12165
|
+
{
|
|
12166
|
+
name: "updateMask",
|
|
12167
|
+
type: "string",
|
|
12168
|
+
required: false,
|
|
12169
|
+
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."
|
|
12170
|
+
}
|
|
12171
|
+
]
|
|
12172
|
+
}
|
|
12173
|
+
},
|
|
12174
|
+
{
|
|
12175
|
+
resource: "devops.testPlans",
|
|
12176
|
+
method: "pause",
|
|
12177
|
+
summary: "Pause a test plan",
|
|
12178
|
+
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.",
|
|
12179
|
+
http: "POST",
|
|
12180
|
+
path: "/devops/v1/test-plans/{id}:pause",
|
|
12181
|
+
streaming: "no",
|
|
12182
|
+
pagination: false,
|
|
12183
|
+
pathParams: [
|
|
12184
|
+
{
|
|
12185
|
+
name: "id",
|
|
12186
|
+
sdkName: "id",
|
|
12187
|
+
description: "The plan identifier returned by a plan list or create answer."
|
|
12188
|
+
}
|
|
12189
|
+
],
|
|
12190
|
+
query: [],
|
|
12191
|
+
body: {
|
|
12192
|
+
required: true,
|
|
12193
|
+
fields: [
|
|
12194
|
+
{
|
|
12195
|
+
name: "reason",
|
|
12196
|
+
type: "string",
|
|
12197
|
+
required: true,
|
|
12198
|
+
description: "Why the plan is being paused; it is stored on the plan and read by whoever finds it stopped."
|
|
12199
|
+
},
|
|
12200
|
+
{
|
|
12201
|
+
name: "until",
|
|
12202
|
+
type: "string",
|
|
12203
|
+
required: false,
|
|
12204
|
+
description: "RFC 3339 UTC time the plan resumes by itself; omit it to stay paused until someone resumes it."
|
|
12205
|
+
}
|
|
12206
|
+
]
|
|
12207
|
+
}
|
|
12208
|
+
},
|
|
12209
|
+
{
|
|
12210
|
+
resource: "devops.testPlans",
|
|
12211
|
+
method: "resume",
|
|
12212
|
+
summary: "Resume a test plan",
|
|
12213
|
+
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.",
|
|
12214
|
+
http: "POST",
|
|
12215
|
+
path: "/devops/v1/test-plans/{id}:resume",
|
|
12216
|
+
streaming: "no",
|
|
12217
|
+
pagination: false,
|
|
12218
|
+
pathParams: [
|
|
12219
|
+
{
|
|
12220
|
+
name: "id",
|
|
12221
|
+
sdkName: "id",
|
|
12222
|
+
description: "The plan identifier returned by a plan list or create answer."
|
|
12223
|
+
}
|
|
12224
|
+
],
|
|
12225
|
+
query: []
|
|
12226
|
+
},
|
|
12227
|
+
{
|
|
12228
|
+
resource: "devops.testRuns",
|
|
12229
|
+
method: "retrieve",
|
|
12230
|
+
summary: "Retrieve a test run",
|
|
12231
|
+
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.",
|
|
12232
|
+
http: "GET",
|
|
12233
|
+
path: "/devops/v1/test-runs/{id}",
|
|
12234
|
+
streaming: "no",
|
|
12235
|
+
pagination: false,
|
|
12236
|
+
pathParams: [
|
|
12237
|
+
{
|
|
12238
|
+
name: "id",
|
|
12239
|
+
sdkName: "id",
|
|
12240
|
+
description: "The run identifier returned by a run list or create answer."
|
|
12241
|
+
}
|
|
12242
|
+
],
|
|
12243
|
+
query: [
|
|
12244
|
+
{
|
|
12245
|
+
name: "expand",
|
|
12246
|
+
type: "array",
|
|
12247
|
+
itemType: "string",
|
|
12248
|
+
enum: [
|
|
12249
|
+
"failedExecutions"
|
|
12250
|
+
],
|
|
12251
|
+
required: false,
|
|
12252
|
+
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."
|
|
12253
|
+
}
|
|
12254
|
+
]
|
|
12255
|
+
},
|
|
12256
|
+
{
|
|
12257
|
+
resource: "devops.testRuns",
|
|
12258
|
+
method: "cancel",
|
|
12259
|
+
summary: "Cancel a test run",
|
|
12260
|
+
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.",
|
|
12261
|
+
http: "POST",
|
|
12262
|
+
path: "/devops/v1/test-runs/{id}:cancel",
|
|
12263
|
+
streaming: "no",
|
|
12264
|
+
pagination: false,
|
|
12265
|
+
pathParams: [
|
|
12266
|
+
{
|
|
12267
|
+
name: "id",
|
|
12268
|
+
sdkName: "id",
|
|
12269
|
+
description: "The run identifier returned by a run list or create answer."
|
|
12270
|
+
}
|
|
12271
|
+
],
|
|
12272
|
+
query: [],
|
|
12273
|
+
body: {
|
|
12274
|
+
required: true,
|
|
12275
|
+
fields: [
|
|
12276
|
+
{
|
|
12277
|
+
name: "reason",
|
|
12278
|
+
type: "string",
|
|
12279
|
+
required: true,
|
|
12280
|
+
description: "Why the run is being cancelled; it is stored on the run and is what a later reader finds instead of a result."
|
|
12281
|
+
}
|
|
12282
|
+
]
|
|
12283
|
+
}
|
|
12284
|
+
},
|
|
12285
|
+
{
|
|
12286
|
+
resource: "devops.testRuns.executions",
|
|
12287
|
+
method: "list",
|
|
12288
|
+
summary: "List a run's executions",
|
|
12289
|
+
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.",
|
|
12290
|
+
http: "GET",
|
|
12291
|
+
path: "/devops/v1/test-runs/{run}/executions",
|
|
12292
|
+
streaming: "no",
|
|
12293
|
+
pagination: false,
|
|
12294
|
+
pathParams: [
|
|
12295
|
+
{
|
|
12296
|
+
name: "run",
|
|
12297
|
+
sdkName: "run",
|
|
12298
|
+
description: "The run whose executions you are reading, from a run list or create answer."
|
|
12299
|
+
}
|
|
12300
|
+
],
|
|
12301
|
+
query: [
|
|
12302
|
+
{
|
|
12303
|
+
name: "pageSize",
|
|
12304
|
+
type: "integer",
|
|
12305
|
+
required: false,
|
|
12306
|
+
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."
|
|
12307
|
+
},
|
|
12308
|
+
{
|
|
12309
|
+
name: "pageToken",
|
|
12310
|
+
type: "string",
|
|
12311
|
+
required: false,
|
|
12312
|
+
description: "The cursor from the previous page's nextPageToken. Treat it as opaque and never build one yourself; omit it for the first page."
|
|
12313
|
+
},
|
|
12314
|
+
{
|
|
12315
|
+
name: "filter",
|
|
12316
|
+
type: "string",
|
|
12317
|
+
required: false,
|
|
12318
|
+
description: "AIP-160 equality filter over one declared field, for example result=failed to read only a run's failures. Fields an execution list does not declare are refused with INVALID_ARGUMENT rather than ignored."
|
|
12319
|
+
},
|
|
12320
|
+
{
|
|
12321
|
+
name: "orderBy",
|
|
12322
|
+
type: "string",
|
|
12323
|
+
required: false,
|
|
12324
|
+
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."
|
|
12325
|
+
}
|
|
12326
|
+
]
|
|
12327
|
+
},
|
|
12328
|
+
{
|
|
12329
|
+
resource: "devops.testRuns.executions",
|
|
12330
|
+
method: "retrieve",
|
|
12331
|
+
summary: "Retrieve one case's execution in a run",
|
|
12332
|
+
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.",
|
|
12333
|
+
http: "GET",
|
|
12334
|
+
path: "/devops/v1/test-runs/{run}/executions/{case}",
|
|
12335
|
+
streaming: "no",
|
|
12336
|
+
pagination: false,
|
|
12337
|
+
pathParams: [
|
|
12338
|
+
{
|
|
12339
|
+
name: "run",
|
|
12340
|
+
sdkName: "run",
|
|
12341
|
+
description: "The run whose executions you are reading, from a run list or create answer."
|
|
12342
|
+
},
|
|
12343
|
+
{
|
|
12344
|
+
name: "case",
|
|
12345
|
+
sdkName: "case",
|
|
12346
|
+
description: "The case to read inside that run, from the run's execution list or the project's case list."
|
|
12347
|
+
}
|
|
12348
|
+
],
|
|
12349
|
+
query: []
|
|
12350
|
+
},
|
|
12351
|
+
{
|
|
12352
|
+
resource: "devops.testSuites",
|
|
12353
|
+
method: "retrieve",
|
|
12354
|
+
summary: "Retrieve a test suite",
|
|
12355
|
+
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.",
|
|
12356
|
+
http: "GET",
|
|
12357
|
+
path: "/devops/v1/test-suites/{id}",
|
|
12358
|
+
streaming: "no",
|
|
12359
|
+
pagination: false,
|
|
12360
|
+
pathParams: [
|
|
12361
|
+
{
|
|
12362
|
+
name: "id",
|
|
12363
|
+
sdkName: "id",
|
|
12364
|
+
description: "The suite identifier returned by a suite list, not the file path it was discovered from."
|
|
12365
|
+
}
|
|
12366
|
+
],
|
|
12367
|
+
query: []
|
|
12368
|
+
},
|
|
11422
12369
|
{
|
|
11423
12370
|
resource: "file.files",
|
|
11424
12371
|
method: "list",
|
|
@@ -11630,7 +12577,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11630
12577
|
resource: "file.uploads",
|
|
11631
12578
|
method: "create",
|
|
11632
12579
|
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
|
|
12580
|
+
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
12581
|
http: "POST",
|
|
11635
12582
|
path: "/file/v1/uploads",
|
|
11636
12583
|
streaming: "no",
|
|
@@ -11644,7 +12591,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11644
12591
|
name: "bytes",
|
|
11645
12592
|
type: "integer",
|
|
11646
12593
|
required: true,
|
|
11647
|
-
description: "Exact complete file length in bytes, from 1 through
|
|
12594
|
+
description: "Exact complete file length in bytes, from 1 through 21474836480 (20 GiB); the sum of completed parts must match."
|
|
11648
12595
|
},
|
|
11649
12596
|
{
|
|
11650
12597
|
name: "filename",
|
|
@@ -11688,7 +12635,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11688
12635
|
resource: "file.uploads",
|
|
11689
12636
|
method: "createSigned",
|
|
11690
12637
|
summary: "Create a one-time upload URL",
|
|
11691
|
-
description: "Upload a local file of up to
|
|
12638
|
+
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
12639
|
http: "POST",
|
|
11693
12640
|
path: "/file/v1/uploads/signed",
|
|
11694
12641
|
streaming: "no",
|
|
@@ -11708,7 +12655,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11708
12655
|
name: "bytes",
|
|
11709
12656
|
type: "integer",
|
|
11710
12657
|
required: true,
|
|
11711
|
-
description: "Exact local file size in bytes, from 1 through
|
|
12658
|
+
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
12659
|
},
|
|
11713
12660
|
{
|
|
11714
12661
|
name: "content_type",
|
|
@@ -11731,7 +12678,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11731
12678
|
name: "expires_in",
|
|
11732
12679
|
type: "integer",
|
|
11733
12680
|
required: false,
|
|
11734
|
-
description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or
|
|
12681
|
+
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
12682
|
},
|
|
11736
12683
|
{
|
|
11737
12684
|
name: "part_size",
|
|
@@ -11742,6 +12689,24 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11742
12689
|
]
|
|
11743
12690
|
}
|
|
11744
12691
|
},
|
|
12692
|
+
{
|
|
12693
|
+
resource: "file.uploads",
|
|
12694
|
+
method: "retrieve",
|
|
12695
|
+
summary: "Retrieve an upload",
|
|
12696
|
+
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.",
|
|
12697
|
+
http: "GET",
|
|
12698
|
+
path: "/file/v1/uploads/{upload_id}",
|
|
12699
|
+
streaming: "no",
|
|
12700
|
+
pagination: false,
|
|
12701
|
+
pathParams: [
|
|
12702
|
+
{
|
|
12703
|
+
name: "upload_id",
|
|
12704
|
+
sdkName: "upload_id",
|
|
12705
|
+
description: "Upload identifier returned by create; the upload must belong to your organization."
|
|
12706
|
+
}
|
|
12707
|
+
],
|
|
12708
|
+
query: []
|
|
12709
|
+
},
|
|
11745
12710
|
{
|
|
11746
12711
|
resource: "file.uploads",
|
|
11747
12712
|
method: "cancel",
|
|
@@ -11764,7 +12729,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11764
12729
|
resource: "file.uploads",
|
|
11765
12730
|
method: "complete",
|
|
11766
12731
|
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.",
|
|
12732
|
+
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
12733
|
http: "POST",
|
|
11769
12734
|
path: "/file/v1/uploads/{upload_id}/complete",
|
|
11770
12735
|
streaming: "no",
|
|
@@ -11800,7 +12765,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
11800
12765
|
resource: "file.uploads.parts",
|
|
11801
12766
|
method: "create",
|
|
11802
12767
|
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.",
|
|
12768
|
+
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
12769
|
http: "POST",
|
|
11805
12770
|
path: "/file/v1/uploads/{upload_id}/parts",
|
|
11806
12771
|
streaming: "no",
|
|
@@ -12849,7 +13814,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12849
13814
|
resource: "media.libraries.assets",
|
|
12850
13815
|
method: "create",
|
|
12851
13816
|
summary: "Upload asset",
|
|
12852
|
-
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.
|
|
13817
|
+
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.",
|
|
12853
13818
|
http: "POST",
|
|
12854
13819
|
path: "/media/v1/libraries/{library_id}/assets",
|
|
12855
13820
|
streaming: "no",
|
|
@@ -12973,7 +13938,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
12973
13938
|
resource: "media.libraries.assets.import",
|
|
12974
13939
|
method: "create",
|
|
12975
13940
|
summary: "Import file",
|
|
12976
|
-
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.
|
|
13941
|
+
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.",
|
|
12977
13942
|
http: "POST",
|
|
12978
13943
|
path: "/media/v1/libraries/{library_id}/assets/import",
|
|
12979
13944
|
streaming: "no",
|
|
@@ -13241,7 +14206,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13241
14206
|
resource: "media.libraries.assets.reprocess",
|
|
13242
14207
|
method: "create",
|
|
13243
14208
|
summary: "Reprocess asset",
|
|
13244
|
-
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.
|
|
14209
|
+
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.",
|
|
13245
14210
|
http: "POST",
|
|
13246
14211
|
path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess",
|
|
13247
14212
|
streaming: "no",
|
|
@@ -13317,10 +14282,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13317
14282
|
"frame",
|
|
13318
14283
|
"overview",
|
|
13319
14284
|
"audio",
|
|
14285
|
+
"loudness",
|
|
14286
|
+
"beats",
|
|
14287
|
+
"content",
|
|
13320
14288
|
"embedding"
|
|
13321
14289
|
],
|
|
13322
14290
|
required: false,
|
|
13323
|
-
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."
|
|
14291
|
+
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."
|
|
13324
14292
|
},
|
|
13325
14293
|
{
|
|
13326
14294
|
name: "cursor",
|
|
@@ -13340,7 +14308,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13340
14308
|
resource: "media.libraries.assets",
|
|
13341
14309
|
method: "batch",
|
|
13342
14310
|
summary: "Batch assets alias",
|
|
13343
|
-
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.
|
|
14311
|
+
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.',
|
|
13344
14312
|
http: "POST",
|
|
13345
14313
|
path: "/media/v1/libraries/{library_id}/assets:batch",
|
|
13346
14314
|
streaming: "no",
|
|
@@ -13375,7 +14343,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
13375
14343
|
resource: "media.libraries.batches",
|
|
13376
14344
|
method: "create",
|
|
13377
14345
|
summary: "Create batch",
|
|
13378
|
-
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.
|
|
14346
|
+
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.',
|
|
13379
14347
|
http: "POST",
|
|
13380
14348
|
path: "/media/v1/libraries/{library_id}/batches",
|
|
13381
14349
|
streaming: "no",
|
|
@@ -14072,7 +15040,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
14072
15040
|
name: "kinds",
|
|
14073
15041
|
type: "string",
|
|
14074
15042
|
required: false,
|
|
14075
|
-
description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind."
|
|
15043
|
+
description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, loudness, beats, content, embedding. Omit or empty to include every kind."
|
|
14076
15044
|
},
|
|
14077
15045
|
{
|
|
14078
15046
|
name: "cursor",
|
|
@@ -16588,6 +17556,539 @@ for more details.`
|
|
|
16588
17556
|
],
|
|
16589
17557
|
query: []
|
|
16590
17558
|
},
|
|
17559
|
+
{
|
|
17560
|
+
resource: "ontology.changesets",
|
|
17561
|
+
method: "create",
|
|
17562
|
+
summary: "Apply changeset",
|
|
17563
|
+
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.",
|
|
17564
|
+
http: "POST",
|
|
17565
|
+
path: "/ontology/v1/changesets",
|
|
17566
|
+
streaming: "no",
|
|
17567
|
+
pagination: false,
|
|
17568
|
+
pathParams: [],
|
|
17569
|
+
query: [],
|
|
17570
|
+
body: {
|
|
17571
|
+
required: true,
|
|
17572
|
+
fields: [
|
|
17573
|
+
{
|
|
17574
|
+
name: "at",
|
|
17575
|
+
type: "string",
|
|
17576
|
+
required: true,
|
|
17577
|
+
description: "World time the batch describes, in ISO 8601 UTC; operations without their own time are dated by it."
|
|
17578
|
+
},
|
|
17579
|
+
{
|
|
17580
|
+
name: "scope",
|
|
17581
|
+
type: "string",
|
|
17582
|
+
required: false,
|
|
17583
|
+
description: "Scope the batch came from, normally the session id it was observed in; it is stored with the operations for later reading."
|
|
17584
|
+
},
|
|
17585
|
+
{
|
|
17586
|
+
name: "ops",
|
|
17587
|
+
type: "array",
|
|
17588
|
+
itemType: "object",
|
|
17589
|
+
required: true,
|
|
17590
|
+
description: "At most 500 operations, applied in order; each names its kind in op and the fields that kind requires."
|
|
17591
|
+
}
|
|
17592
|
+
]
|
|
17593
|
+
}
|
|
17594
|
+
},
|
|
17595
|
+
{
|
|
17596
|
+
resource: "ontology.nodes",
|
|
17597
|
+
method: "list",
|
|
17598
|
+
summary: "List nodes",
|
|
17599
|
+
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.",
|
|
17600
|
+
http: "GET",
|
|
17601
|
+
path: "/ontology/v1/nodes",
|
|
17602
|
+
streaming: "no",
|
|
17603
|
+
pagination: true,
|
|
17604
|
+
pathParams: [],
|
|
17605
|
+
query: [
|
|
17606
|
+
{
|
|
17607
|
+
name: "type",
|
|
17608
|
+
type: "array",
|
|
17609
|
+
itemType: "string",
|
|
17610
|
+
required: false,
|
|
17611
|
+
description: "Repeat to filter to any of several registered node type names, for example type=file&type=ticket; omit to list every type."
|
|
17612
|
+
},
|
|
17613
|
+
{
|
|
17614
|
+
name: "q",
|
|
17615
|
+
type: "string",
|
|
17616
|
+
required: false,
|
|
17617
|
+
description: "Free text matched against node names, aliases and descriptions; omit to list without a text filter."
|
|
17618
|
+
},
|
|
17619
|
+
{
|
|
17620
|
+
name: "owner",
|
|
17621
|
+
type: "string",
|
|
17622
|
+
required: false,
|
|
17623
|
+
description: "Filter to nodes owned by this member id, or omit to list nodes of every owner; organization-wide nodes carry no owner."
|
|
17624
|
+
},
|
|
17625
|
+
{
|
|
17626
|
+
name: "as_of",
|
|
17627
|
+
type: "string",
|
|
17628
|
+
required: false,
|
|
17629
|
+
description: "ISO 8601 timestamp; return the graph as it was then, so a node recorded later is absent. Omit to read current state."
|
|
17630
|
+
},
|
|
17631
|
+
{
|
|
17632
|
+
name: "limit",
|
|
17633
|
+
type: "integer",
|
|
17634
|
+
required: false,
|
|
17635
|
+
description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100."
|
|
17636
|
+
},
|
|
17637
|
+
{
|
|
17638
|
+
name: "cursor",
|
|
17639
|
+
type: "string",
|
|
17640
|
+
required: false,
|
|
17641
|
+
description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
|
|
17642
|
+
}
|
|
17643
|
+
]
|
|
17644
|
+
},
|
|
17645
|
+
{
|
|
17646
|
+
resource: "ontology.nodes",
|
|
17647
|
+
method: "create",
|
|
17648
|
+
summary: "Create node",
|
|
17649
|
+
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.",
|
|
17650
|
+
http: "POST",
|
|
17651
|
+
path: "/ontology/v1/nodes",
|
|
17652
|
+
streaming: "no",
|
|
17653
|
+
pagination: false,
|
|
17654
|
+
pathParams: [],
|
|
17655
|
+
query: [],
|
|
17656
|
+
body: {
|
|
17657
|
+
required: true,
|
|
17658
|
+
fields: [
|
|
17659
|
+
{
|
|
17660
|
+
name: "type",
|
|
17661
|
+
type: "string",
|
|
17662
|
+
required: true,
|
|
17663
|
+
description: "Registered node type name from types.list; an unregistered name is refused and nothing is written."
|
|
17664
|
+
},
|
|
17665
|
+
{
|
|
17666
|
+
name: "ref",
|
|
17667
|
+
type: "string",
|
|
17668
|
+
required: false,
|
|
17669
|
+
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."
|
|
17670
|
+
},
|
|
17671
|
+
{
|
|
17672
|
+
name: "name",
|
|
17673
|
+
type: "string",
|
|
17674
|
+
required: true,
|
|
17675
|
+
description: "Display name of the entity, at most 200 characters."
|
|
17676
|
+
},
|
|
17677
|
+
{
|
|
17678
|
+
name: "aliases",
|
|
17679
|
+
type: "array",
|
|
17680
|
+
itemType: "string",
|
|
17681
|
+
required: false,
|
|
17682
|
+
description: "Other names this entity is known by; they are matched by search alongside the name."
|
|
17683
|
+
},
|
|
17684
|
+
{
|
|
17685
|
+
name: "description",
|
|
17686
|
+
type: "string",
|
|
17687
|
+
required: false,
|
|
17688
|
+
description: "Profile of the entity, at most 500 characters; omit or null for none."
|
|
17689
|
+
},
|
|
17690
|
+
{
|
|
17691
|
+
name: "owner",
|
|
17692
|
+
type: "string",
|
|
17693
|
+
required: false,
|
|
17694
|
+
description: "Member id whose content this is, restricting it to that member; omit or null to make it readable organization-wide."
|
|
17695
|
+
}
|
|
17696
|
+
]
|
|
17697
|
+
}
|
|
17698
|
+
},
|
|
17699
|
+
{
|
|
17700
|
+
resource: "ontology.nodes",
|
|
17701
|
+
method: "retrieve",
|
|
17702
|
+
summary: "Retrieve node",
|
|
17703
|
+
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.",
|
|
17704
|
+
http: "GET",
|
|
17705
|
+
path: "/ontology/v1/nodes/{node_id}",
|
|
17706
|
+
streaming: "no",
|
|
17707
|
+
pagination: false,
|
|
17708
|
+
pathParams: [
|
|
17709
|
+
{
|
|
17710
|
+
name: "node_id",
|
|
17711
|
+
sdkName: "node_id",
|
|
17712
|
+
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."
|
|
17713
|
+
}
|
|
17714
|
+
],
|
|
17715
|
+
query: [
|
|
17716
|
+
{
|
|
17717
|
+
name: "expand",
|
|
17718
|
+
type: "string",
|
|
17719
|
+
enum: [
|
|
17720
|
+
"relations"
|
|
17721
|
+
],
|
|
17722
|
+
required: false,
|
|
17723
|
+
description: "Set to relations to include the node's incoming and outgoing relations in the same response; omit for the node alone."
|
|
17724
|
+
},
|
|
17725
|
+
{
|
|
17726
|
+
name: "as_of",
|
|
17727
|
+
type: "string",
|
|
17728
|
+
required: false,
|
|
17729
|
+
description: "ISO 8601 timestamp; read the node and its relations as they were then, including relations invalidated since. Omit to read current state."
|
|
17730
|
+
}
|
|
17731
|
+
]
|
|
17732
|
+
},
|
|
17733
|
+
{
|
|
17734
|
+
resource: "ontology.nodes",
|
|
17735
|
+
method: "update",
|
|
17736
|
+
summary: "Update node",
|
|
17737
|
+
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.",
|
|
17738
|
+
http: "PATCH",
|
|
17739
|
+
path: "/ontology/v1/nodes/{node_id}",
|
|
17740
|
+
streaming: "no",
|
|
17741
|
+
pagination: false,
|
|
17742
|
+
pathParams: [
|
|
17743
|
+
{
|
|
17744
|
+
name: "node_id",
|
|
17745
|
+
sdkName: "node_id",
|
|
17746
|
+
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."
|
|
17747
|
+
}
|
|
17748
|
+
],
|
|
17749
|
+
query: [],
|
|
17750
|
+
body: {
|
|
17751
|
+
required: true,
|
|
17752
|
+
fields: [
|
|
17753
|
+
{
|
|
17754
|
+
name: "name",
|
|
17755
|
+
type: "string",
|
|
17756
|
+
required: false,
|
|
17757
|
+
description: "New display name, at most 200 characters; omit to keep the current name."
|
|
17758
|
+
},
|
|
17759
|
+
{
|
|
17760
|
+
name: "aliases",
|
|
17761
|
+
type: "array",
|
|
17762
|
+
itemType: "string",
|
|
17763
|
+
required: false,
|
|
17764
|
+
description: "Replacement alias list; an empty array clears the aliases and omitting the field keeps them."
|
|
17765
|
+
},
|
|
17766
|
+
{
|
|
17767
|
+
name: "description",
|
|
17768
|
+
type: "string",
|
|
17769
|
+
required: false,
|
|
17770
|
+
description: "Replacement profile, at most 500 characters; an explicit null clears it and omitting the field keeps it."
|
|
17771
|
+
}
|
|
17772
|
+
]
|
|
17773
|
+
}
|
|
17774
|
+
},
|
|
17775
|
+
{
|
|
17776
|
+
resource: "ontology.nodes.merge",
|
|
17777
|
+
method: "create",
|
|
17778
|
+
summary: "Merge node",
|
|
17779
|
+
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.",
|
|
17780
|
+
http: "POST",
|
|
17781
|
+
path: "/ontology/v1/nodes/{node_id}/merge",
|
|
17782
|
+
streaming: "no",
|
|
17783
|
+
pagination: false,
|
|
17784
|
+
pathParams: [
|
|
17785
|
+
{
|
|
17786
|
+
name: "node_id",
|
|
17787
|
+
sdkName: "node_id",
|
|
17788
|
+
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."
|
|
17789
|
+
}
|
|
17790
|
+
],
|
|
17791
|
+
query: [],
|
|
17792
|
+
body: {
|
|
17793
|
+
required: true,
|
|
17794
|
+
fields: [
|
|
17795
|
+
{
|
|
17796
|
+
name: "into",
|
|
17797
|
+
type: "string",
|
|
17798
|
+
required: true,
|
|
17799
|
+
description: "Node id that should survive, from nodes.list or search; the merged node's relations and aliases move to it."
|
|
17800
|
+
}
|
|
17801
|
+
]
|
|
17802
|
+
}
|
|
17803
|
+
},
|
|
17804
|
+
{
|
|
17805
|
+
resource: "ontology.relations",
|
|
17806
|
+
method: "list",
|
|
17807
|
+
summary: "List relations",
|
|
17808
|
+
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.",
|
|
17809
|
+
http: "GET",
|
|
17810
|
+
path: "/ontology/v1/relations",
|
|
17811
|
+
streaming: "no",
|
|
17812
|
+
pagination: true,
|
|
17813
|
+
pathParams: [],
|
|
17814
|
+
query: [
|
|
17815
|
+
{
|
|
17816
|
+
name: "node",
|
|
17817
|
+
type: "string",
|
|
17818
|
+
required: false,
|
|
17819
|
+
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."
|
|
17820
|
+
},
|
|
17821
|
+
{
|
|
17822
|
+
name: "type",
|
|
17823
|
+
type: "array",
|
|
17824
|
+
itemType: "string",
|
|
17825
|
+
required: false,
|
|
17826
|
+
description: "Repeat to filter to any of several registered relation type names, for example type=references&type=serves; omit to list every type."
|
|
17827
|
+
},
|
|
17828
|
+
{
|
|
17829
|
+
name: "direction",
|
|
17830
|
+
type: "string",
|
|
17831
|
+
enum: [
|
|
17832
|
+
"out",
|
|
17833
|
+
"in",
|
|
17834
|
+
"both"
|
|
17835
|
+
],
|
|
17836
|
+
required: false,
|
|
17837
|
+
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."
|
|
17838
|
+
},
|
|
17839
|
+
{
|
|
17840
|
+
name: "as_of",
|
|
17841
|
+
type: "string",
|
|
17842
|
+
required: false,
|
|
17843
|
+
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."
|
|
17844
|
+
},
|
|
17845
|
+
{
|
|
17846
|
+
name: "include_invalid",
|
|
17847
|
+
type: "boolean",
|
|
17848
|
+
required: false,
|
|
17849
|
+
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."
|
|
17850
|
+
},
|
|
17851
|
+
{
|
|
17852
|
+
name: "limit",
|
|
17853
|
+
type: "integer",
|
|
17854
|
+
required: false,
|
|
17855
|
+
description: "Maximum items to return per page, from 1 to 100; defaults to 50 when omitted. Values above 100 are clamped to 100."
|
|
17856
|
+
},
|
|
17857
|
+
{
|
|
17858
|
+
name: "cursor",
|
|
17859
|
+
type: "string",
|
|
17860
|
+
required: false,
|
|
17861
|
+
description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
|
|
17862
|
+
}
|
|
17863
|
+
]
|
|
17864
|
+
},
|
|
17865
|
+
{
|
|
17866
|
+
resource: "ontology.relations",
|
|
17867
|
+
method: "create",
|
|
17868
|
+
summary: "Create relation",
|
|
17869
|
+
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.",
|
|
17870
|
+
http: "POST",
|
|
17871
|
+
path: "/ontology/v1/relations",
|
|
17872
|
+
streaming: "no",
|
|
17873
|
+
pagination: false,
|
|
17874
|
+
pathParams: [],
|
|
17875
|
+
query: [],
|
|
17876
|
+
body: {
|
|
17877
|
+
required: true,
|
|
17878
|
+
fields: [
|
|
17879
|
+
{
|
|
17880
|
+
name: "type",
|
|
17881
|
+
type: "string",
|
|
17882
|
+
required: true,
|
|
17883
|
+
description: "Registered relation type name from types.list; it must admit both endpoints or the write is refused."
|
|
17884
|
+
},
|
|
17885
|
+
{
|
|
17886
|
+
name: "source",
|
|
17887
|
+
type: "string",
|
|
17888
|
+
required: true,
|
|
17889
|
+
description: "Node id the fact starts from, from nodes.list or nodes.create."
|
|
17890
|
+
},
|
|
17891
|
+
{
|
|
17892
|
+
name: "target",
|
|
17893
|
+
type: "string",
|
|
17894
|
+
required: true,
|
|
17895
|
+
description: "Node id the fact points at, from nodes.list or nodes.create."
|
|
17896
|
+
},
|
|
17897
|
+
{
|
|
17898
|
+
name: "fact",
|
|
17899
|
+
type: "string",
|
|
17900
|
+
required: true,
|
|
17901
|
+
description: "The relationship in one sentence, at most 280 characters, written to read back on its own."
|
|
17902
|
+
},
|
|
17903
|
+
{
|
|
17904
|
+
name: "valid_at",
|
|
17905
|
+
type: "string",
|
|
17906
|
+
required: false,
|
|
17907
|
+
description: "World time the fact became true, when the mirrored record dates it; omit to leave it undated."
|
|
17908
|
+
},
|
|
17909
|
+
{
|
|
17910
|
+
name: "owner",
|
|
17911
|
+
type: "string",
|
|
17912
|
+
required: false,
|
|
17913
|
+
description: "Member id whose content this fact is, restricting it to that member; omit or null for organization-wide."
|
|
17914
|
+
}
|
|
17915
|
+
]
|
|
17916
|
+
}
|
|
17917
|
+
},
|
|
17918
|
+
{
|
|
17919
|
+
resource: "ontology.relations",
|
|
17920
|
+
method: "retrieve",
|
|
17921
|
+
summary: "Retrieve relation",
|
|
17922
|
+
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.",
|
|
17923
|
+
http: "GET",
|
|
17924
|
+
path: "/ontology/v1/relations/{relation_id}",
|
|
17925
|
+
streaming: "no",
|
|
17926
|
+
pagination: false,
|
|
17927
|
+
pathParams: [
|
|
17928
|
+
{
|
|
17929
|
+
name: "relation_id",
|
|
17930
|
+
sdkName: "relation_id",
|
|
17931
|
+
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."
|
|
17932
|
+
}
|
|
17933
|
+
],
|
|
17934
|
+
query: []
|
|
17935
|
+
},
|
|
17936
|
+
{
|
|
17937
|
+
resource: "ontology.relations.invalidate",
|
|
17938
|
+
method: "create",
|
|
17939
|
+
summary: "Invalidate relation",
|
|
17940
|
+
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.",
|
|
17941
|
+
http: "POST",
|
|
17942
|
+
path: "/ontology/v1/relations/{relation_id}/invalidate",
|
|
17943
|
+
streaming: "no",
|
|
17944
|
+
pagination: false,
|
|
17945
|
+
pathParams: [
|
|
17946
|
+
{
|
|
17947
|
+
name: "relation_id",
|
|
17948
|
+
sdkName: "relation_id",
|
|
17949
|
+
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."
|
|
17950
|
+
}
|
|
17951
|
+
],
|
|
17952
|
+
query: [],
|
|
17953
|
+
body: {
|
|
17954
|
+
required: true,
|
|
17955
|
+
fields: [
|
|
17956
|
+
{
|
|
17957
|
+
name: "invalid_at",
|
|
17958
|
+
type: "string",
|
|
17959
|
+
required: true,
|
|
17960
|
+
description: "World time the fact stopped being true, in ISO 8601 UTC; reads at an earlier as_of still return the relation."
|
|
17961
|
+
},
|
|
17962
|
+
{
|
|
17963
|
+
name: "superseded_by",
|
|
17964
|
+
type: "string",
|
|
17965
|
+
required: false,
|
|
17966
|
+
description: "Relation id that replaces this one, when a successor was recorded; omit or null when nothing replaced it."
|
|
17967
|
+
},
|
|
17968
|
+
{
|
|
17969
|
+
name: "reason",
|
|
17970
|
+
type: "string",
|
|
17971
|
+
required: false,
|
|
17972
|
+
description: "Why it stopped being true, for people reading the history later; not enforced and safe to omit."
|
|
17973
|
+
}
|
|
17974
|
+
]
|
|
17975
|
+
}
|
|
17976
|
+
},
|
|
17977
|
+
{
|
|
17978
|
+
resource: "ontology.search",
|
|
17979
|
+
method: "create",
|
|
17980
|
+
summary: "Search nodes",
|
|
17981
|
+
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.",
|
|
17982
|
+
http: "POST",
|
|
17983
|
+
path: "/ontology/v1/search",
|
|
17984
|
+
streaming: "no",
|
|
17985
|
+
pagination: false,
|
|
17986
|
+
pathParams: [],
|
|
17987
|
+
query: [],
|
|
17988
|
+
body: {
|
|
17989
|
+
required: true,
|
|
17990
|
+
fields: [
|
|
17991
|
+
{
|
|
17992
|
+
name: "text",
|
|
17993
|
+
type: "string",
|
|
17994
|
+
required: true,
|
|
17995
|
+
description: "Text to find nodes for, matched against names, aliases, descriptions and relation facts; an empty string is refused."
|
|
17996
|
+
},
|
|
17997
|
+
{
|
|
17998
|
+
name: "types",
|
|
17999
|
+
type: "array",
|
|
18000
|
+
itemType: "string",
|
|
18001
|
+
required: false,
|
|
18002
|
+
description: "Registered node type names to search within; omit to search every type."
|
|
18003
|
+
},
|
|
18004
|
+
{
|
|
18005
|
+
name: "window",
|
|
18006
|
+
type: "object",
|
|
18007
|
+
required: false,
|
|
18008
|
+
description: "Restrict matches to facts recorded within a period; omit to search all time."
|
|
18009
|
+
},
|
|
18010
|
+
{
|
|
18011
|
+
name: "limit",
|
|
18012
|
+
type: "integer",
|
|
18013
|
+
required: false,
|
|
18014
|
+
description: "Maximum candidate nodes to return, from 1 to 50; defaults to 20 when omitted."
|
|
18015
|
+
}
|
|
18016
|
+
]
|
|
18017
|
+
}
|
|
18018
|
+
},
|
|
18019
|
+
{
|
|
18020
|
+
resource: "ontology.types",
|
|
18021
|
+
method: "list",
|
|
18022
|
+
summary: "List types",
|
|
18023
|
+
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.",
|
|
18024
|
+
http: "GET",
|
|
18025
|
+
path: "/ontology/v1/types",
|
|
18026
|
+
streaming: "no",
|
|
18027
|
+
pagination: false,
|
|
18028
|
+
pathParams: [],
|
|
18029
|
+
query: []
|
|
18030
|
+
},
|
|
18031
|
+
{
|
|
18032
|
+
resource: "ontology.types",
|
|
18033
|
+
method: "create",
|
|
18034
|
+
summary: "Register type",
|
|
18035
|
+
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.",
|
|
18036
|
+
http: "POST",
|
|
18037
|
+
path: "/ontology/v1/types",
|
|
18038
|
+
streaming: "no",
|
|
18039
|
+
pagination: false,
|
|
18040
|
+
pathParams: [],
|
|
18041
|
+
query: [],
|
|
18042
|
+
body: {
|
|
18043
|
+
required: true,
|
|
18044
|
+
fields: [
|
|
18045
|
+
{
|
|
18046
|
+
name: "owner",
|
|
18047
|
+
type: "string",
|
|
18048
|
+
required: true,
|
|
18049
|
+
description: "Service that registered these types, for example file or ticket; it is the registrant a later change to a type is checked against."
|
|
18050
|
+
},
|
|
18051
|
+
{
|
|
18052
|
+
name: "version",
|
|
18053
|
+
type: "integer",
|
|
18054
|
+
required: true,
|
|
18055
|
+
description: "Monotonic version of this owner's registration; a later registration must extend this one without removing or narrowing anything."
|
|
18056
|
+
},
|
|
18057
|
+
{
|
|
18058
|
+
name: "nodes",
|
|
18059
|
+
type: "array",
|
|
18060
|
+
itemType: "object",
|
|
18061
|
+
required: true,
|
|
18062
|
+
description: "Node types this owner registers."
|
|
18063
|
+
},
|
|
18064
|
+
{
|
|
18065
|
+
name: "edges",
|
|
18066
|
+
type: "array",
|
|
18067
|
+
itemType: "object",
|
|
18068
|
+
required: true,
|
|
18069
|
+
description: "Relation types this owner registers."
|
|
18070
|
+
}
|
|
18071
|
+
]
|
|
18072
|
+
}
|
|
18073
|
+
},
|
|
18074
|
+
{
|
|
18075
|
+
resource: "ontology.types",
|
|
18076
|
+
method: "retrieve",
|
|
18077
|
+
summary: "Retrieve type",
|
|
18078
|
+
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.",
|
|
18079
|
+
http: "GET",
|
|
18080
|
+
path: "/ontology/v1/types/{name}",
|
|
18081
|
+
streaming: "no",
|
|
18082
|
+
pagination: false,
|
|
18083
|
+
pathParams: [
|
|
18084
|
+
{
|
|
18085
|
+
name: "name",
|
|
18086
|
+
sdkName: "name",
|
|
18087
|
+
description: "A type name from types.list, with its dots preserved — a display label is not accepted."
|
|
18088
|
+
}
|
|
18089
|
+
],
|
|
18090
|
+
query: []
|
|
18091
|
+
},
|
|
16591
18092
|
{
|
|
16592
18093
|
resource: "organization.charges",
|
|
16593
18094
|
method: "list",
|
|
@@ -19311,7 +20812,7 @@ for more details.`
|
|
|
19311
20812
|
resource: "ticket.labels",
|
|
19312
20813
|
method: "create",
|
|
19313
20814
|
summary: "Create or add labels",
|
|
19314
|
-
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.
|
|
20815
|
+
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.",
|
|
19315
20816
|
http: "POST",
|
|
19316
20817
|
path: "/ticket/v1/labels",
|
|
19317
20818
|
streaming: "no",
|
|
@@ -19353,7 +20854,7 @@ for more details.`
|
|
|
19353
20854
|
resource: "ticket.labels",
|
|
19354
20855
|
method: "delete",
|
|
19355
20856
|
summary: "Remove labels",
|
|
19356
|
-
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.
|
|
20857
|
+
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.",
|
|
19357
20858
|
http: "DELETE",
|
|
19358
20859
|
path: "/ticket/v1/labels/{name}",
|
|
19359
20860
|
streaming: "no",
|
|
@@ -19378,7 +20879,7 @@ for more details.`
|
|
|
19378
20879
|
resource: "ticket.labels",
|
|
19379
20880
|
method: "update",
|
|
19380
20881
|
summary: "Update labels",
|
|
19381
|
-
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.
|
|
20882
|
+
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.",
|
|
19382
20883
|
http: "PATCH",
|
|
19383
20884
|
path: "/ticket/v1/labels/{name}",
|
|
19384
20885
|
streaming: "no",
|
|
@@ -20780,7 +22281,7 @@ for more details.`
|
|
|
20780
22281
|
resource: "vault.vaults",
|
|
20781
22282
|
method: "create",
|
|
20782
22283
|
summary: "Create vault",
|
|
20783
|
-
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.
|
|
22284
|
+
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.",
|
|
20784
22285
|
http: "POST",
|
|
20785
22286
|
path: "/vault/v1/vaults",
|
|
20786
22287
|
streaming: "no",
|
|
@@ -21313,6 +22814,8 @@ function problemFrom(status, headers, body, statusText) {
|
|
|
21313
22814
|
param: typeof param === "string" ? param : param === null || nested.param === null ? null : undefined,
|
|
21314
22815
|
errors: Array.isArray(value.errors) ? value.errors : [],
|
|
21315
22816
|
requestId: headers.get("x-request-id") ?? string(value.requestId) ?? string(value.request_id),
|
|
22817
|
+
docUrl: string(nested.doc_url) ?? string(value.doc_url) ?? string(nested.docUrl) ?? string(value.docUrl),
|
|
22818
|
+
describe: string(nested.describe) ?? string(value.describe),
|
|
21316
22819
|
raw: body
|
|
21317
22820
|
};
|
|
21318
22821
|
}
|
|
@@ -21326,6 +22829,8 @@ class PraxisError extends Error {
|
|
|
21326
22829
|
errors;
|
|
21327
22830
|
requestId;
|
|
21328
22831
|
param;
|
|
22832
|
+
docUrl;
|
|
22833
|
+
describe;
|
|
21329
22834
|
raw;
|
|
21330
22835
|
constructor(problem = {}, options) {
|
|
21331
22836
|
super(problem.message ?? problem.detail ?? problem.title ?? `Praxis request failed${problem.status ? ` (${problem.status})` : ""}`, options);
|
|
@@ -21338,6 +22843,8 @@ class PraxisError extends Error {
|
|
|
21338
22843
|
this.errors = problem.errors ?? [];
|
|
21339
22844
|
this.requestId = problem.requestId;
|
|
21340
22845
|
this.param = problem.param;
|
|
22846
|
+
this.docUrl = problem.docUrl;
|
|
22847
|
+
this.describe = problem.describe;
|
|
21341
22848
|
this.raw = problem.raw;
|
|
21342
22849
|
}
|
|
21343
22850
|
static fromResponse(response, body) {
|
|
@@ -22742,6 +24249,23 @@ var computersFilesContent = (options) => (options.client ?? client).get({
|
|
|
22742
24249
|
url: "/agent/v1/computers/{computer_id}/files/content",
|
|
22743
24250
|
...options
|
|
22744
24251
|
});
|
|
24252
|
+
var computersFilesConvert = (options) => (options.client ?? client).post({
|
|
24253
|
+
security: [{
|
|
24254
|
+
key: "BearerAuth",
|
|
24255
|
+
scheme: "bearer",
|
|
24256
|
+
type: "http"
|
|
24257
|
+
}, {
|
|
24258
|
+
key: "ApiKeyAuth",
|
|
24259
|
+
name: "X-API-Key",
|
|
24260
|
+
type: "apiKey"
|
|
24261
|
+
}],
|
|
24262
|
+
url: "/agent/v1/computers/{computer_id}/files/convert",
|
|
24263
|
+
...options,
|
|
24264
|
+
headers: {
|
|
24265
|
+
"Content-Type": "application/json",
|
|
24266
|
+
...options.headers
|
|
24267
|
+
}
|
|
24268
|
+
});
|
|
22745
24269
|
var connectComputer = (options) => (options.client ?? client).post({
|
|
22746
24270
|
security: [{
|
|
22747
24271
|
key: "BearerAuth",
|
|
@@ -23240,6 +24764,15 @@ var fileCancelUpload = (options) => (options.client ?? client).post({
|
|
|
23240
24764
|
url: "/file/v1/uploads/{upload_id}/cancel",
|
|
23241
24765
|
...options
|
|
23242
24766
|
});
|
|
24767
|
+
var fileRetrieveUpload = (options) => (options.client ?? client).get({
|
|
24768
|
+
security: [{
|
|
24769
|
+
key: "BearerAuth",
|
|
24770
|
+
scheme: "bearer",
|
|
24771
|
+
type: "http"
|
|
24772
|
+
}],
|
|
24773
|
+
url: "/file/v1/uploads/{upload_id}",
|
|
24774
|
+
...options
|
|
24775
|
+
});
|
|
23243
24776
|
var fileCreateSignedUpload = (options) => (options.client ?? client).post({
|
|
23244
24777
|
security: [{
|
|
23245
24778
|
key: "BearerAuth",
|
|
@@ -27116,6 +28649,36 @@ var cutCreateExport = (options) => (options.client ?? client).post({
|
|
|
27116
28649
|
...options.headers
|
|
27117
28650
|
}
|
|
27118
28651
|
});
|
|
28652
|
+
var cutCreateRender = (options) => (options.client ?? client).post({
|
|
28653
|
+
security: [{
|
|
28654
|
+
key: "BearerAuth",
|
|
28655
|
+
scheme: "bearer",
|
|
28656
|
+
type: "http"
|
|
28657
|
+
}, {
|
|
28658
|
+
key: "ApiKeyAuth",
|
|
28659
|
+
name: "X-API-Key",
|
|
28660
|
+
type: "apiKey"
|
|
28661
|
+
}],
|
|
28662
|
+
url: "/cut/v1/projects/{project_id}/renders",
|
|
28663
|
+
...options,
|
|
28664
|
+
headers: {
|
|
28665
|
+
"Content-Type": "application/json",
|
|
28666
|
+
...options.headers
|
|
28667
|
+
}
|
|
28668
|
+
});
|
|
28669
|
+
var cutRetrieveRender = (options) => (options.client ?? client).get({
|
|
28670
|
+
security: [{
|
|
28671
|
+
key: "BearerAuth",
|
|
28672
|
+
scheme: "bearer",
|
|
28673
|
+
type: "http"
|
|
28674
|
+
}, {
|
|
28675
|
+
key: "ApiKeyAuth",
|
|
28676
|
+
name: "X-API-Key",
|
|
28677
|
+
type: "apiKey"
|
|
28678
|
+
}],
|
|
28679
|
+
url: "/cut/v1/renders/{render_id}",
|
|
28680
|
+
...options
|
|
28681
|
+
});
|
|
27119
28682
|
var cutRetrieveExport = (options) => (options.client ?? client).get({
|
|
27120
28683
|
security: [{
|
|
27121
28684
|
key: "BearerAuth",
|
|
@@ -27406,6 +28969,201 @@ var databaseInsert = (options) => (options.client ?? client).post({
|
|
|
27406
28969
|
...options.headers
|
|
27407
28970
|
}
|
|
27408
28971
|
});
|
|
28972
|
+
var devopsTestCatalogGet = (options) => (options.client ?? client).get({
|
|
28973
|
+
security: [{
|
|
28974
|
+
key: "devops-bearerAuth",
|
|
28975
|
+
scheme: "bearer",
|
|
28976
|
+
type: "http"
|
|
28977
|
+
}],
|
|
28978
|
+
url: "/devops/v1/projects/{project}/test-catalog",
|
|
28979
|
+
...options
|
|
28980
|
+
});
|
|
28981
|
+
var devopsTestSuitesList = (options) => (options.client ?? client).get({
|
|
28982
|
+
security: [{
|
|
28983
|
+
key: "devops-bearerAuth",
|
|
28984
|
+
scheme: "bearer",
|
|
28985
|
+
type: "http"
|
|
28986
|
+
}],
|
|
28987
|
+
url: "/devops/v1/projects/{project}/test-suites",
|
|
28988
|
+
...options
|
|
28989
|
+
});
|
|
28990
|
+
var devopsTestSuitesGet = (options) => (options.client ?? client).get({
|
|
28991
|
+
security: [{
|
|
28992
|
+
key: "devops-bearerAuth",
|
|
28993
|
+
scheme: "bearer",
|
|
28994
|
+
type: "http"
|
|
28995
|
+
}],
|
|
28996
|
+
url: "/devops/v1/test-suites/{id}",
|
|
28997
|
+
...options
|
|
28998
|
+
});
|
|
28999
|
+
var devopsTestCasesList = (options) => (options.client ?? client).get({
|
|
29000
|
+
security: [{
|
|
29001
|
+
key: "devops-bearerAuth",
|
|
29002
|
+
scheme: "bearer",
|
|
29003
|
+
type: "http"
|
|
29004
|
+
}],
|
|
29005
|
+
url: "/devops/v1/projects/{project}/test-cases",
|
|
29006
|
+
...options
|
|
29007
|
+
});
|
|
29008
|
+
var devopsTestCasesGet = (options) => (options.client ?? client).get({
|
|
29009
|
+
security: [{
|
|
29010
|
+
key: "devops-bearerAuth",
|
|
29011
|
+
scheme: "bearer",
|
|
29012
|
+
type: "http"
|
|
29013
|
+
}],
|
|
29014
|
+
url: "/devops/v1/test-cases/{id}",
|
|
29015
|
+
...options
|
|
29016
|
+
});
|
|
29017
|
+
var devopsTestPlansList = (options) => (options.client ?? client).get({
|
|
29018
|
+
security: [{
|
|
29019
|
+
key: "devops-bearerAuth",
|
|
29020
|
+
scheme: "bearer",
|
|
29021
|
+
type: "http"
|
|
29022
|
+
}],
|
|
29023
|
+
url: "/devops/v1/projects/{project}/test-plans",
|
|
29024
|
+
...options
|
|
29025
|
+
});
|
|
29026
|
+
var devopsTestPlansCreate = (options) => (options.client ?? client).post({
|
|
29027
|
+
security: [{
|
|
29028
|
+
key: "devops-bearerAuth",
|
|
29029
|
+
scheme: "bearer",
|
|
29030
|
+
type: "http"
|
|
29031
|
+
}],
|
|
29032
|
+
url: "/devops/v1/projects/{project}/test-plans",
|
|
29033
|
+
...options,
|
|
29034
|
+
headers: {
|
|
29035
|
+
"Content-Type": "application/json",
|
|
29036
|
+
...options.headers
|
|
29037
|
+
}
|
|
29038
|
+
});
|
|
29039
|
+
var devopsTestPlansDelete = (options) => (options.client ?? client).delete({
|
|
29040
|
+
security: [{
|
|
29041
|
+
key: "devops-bearerAuth",
|
|
29042
|
+
scheme: "bearer",
|
|
29043
|
+
type: "http"
|
|
29044
|
+
}],
|
|
29045
|
+
url: "/devops/v1/test-plans/{id}",
|
|
29046
|
+
...options
|
|
29047
|
+
});
|
|
29048
|
+
var devopsTestPlansGet = (options) => (options.client ?? client).get({
|
|
29049
|
+
security: [{
|
|
29050
|
+
key: "devops-bearerAuth",
|
|
29051
|
+
scheme: "bearer",
|
|
29052
|
+
type: "http"
|
|
29053
|
+
}],
|
|
29054
|
+
url: "/devops/v1/test-plans/{id}",
|
|
29055
|
+
...options
|
|
29056
|
+
});
|
|
29057
|
+
var devopsTestPlansUpdate = (options) => (options.client ?? client).patch({
|
|
29058
|
+
security: [{
|
|
29059
|
+
key: "devops-bearerAuth",
|
|
29060
|
+
scheme: "bearer",
|
|
29061
|
+
type: "http"
|
|
29062
|
+
}],
|
|
29063
|
+
url: "/devops/v1/test-plans/{id}",
|
|
29064
|
+
...options,
|
|
29065
|
+
headers: {
|
|
29066
|
+
"Content-Type": "application/json",
|
|
29067
|
+
...options.headers
|
|
29068
|
+
}
|
|
29069
|
+
});
|
|
29070
|
+
var devopsTestPlansPause = (options) => (options.client ?? client).post({
|
|
29071
|
+
security: [{
|
|
29072
|
+
key: "devops-bearerAuth",
|
|
29073
|
+
scheme: "bearer",
|
|
29074
|
+
type: "http"
|
|
29075
|
+
}],
|
|
29076
|
+
url: "/devops/v1/test-plans/{id}:pause",
|
|
29077
|
+
...options,
|
|
29078
|
+
headers: {
|
|
29079
|
+
"Content-Type": "application/json",
|
|
29080
|
+
...options.headers
|
|
29081
|
+
}
|
|
29082
|
+
});
|
|
29083
|
+
var devopsTestPlansResume = (options) => (options.client ?? client).post({
|
|
29084
|
+
security: [{
|
|
29085
|
+
key: "devops-bearerAuth",
|
|
29086
|
+
scheme: "bearer",
|
|
29087
|
+
type: "http"
|
|
29088
|
+
}],
|
|
29089
|
+
url: "/devops/v1/test-plans/{id}:resume",
|
|
29090
|
+
...options
|
|
29091
|
+
});
|
|
29092
|
+
var devopsTestRunsList = (options) => (options.client ?? client).get({
|
|
29093
|
+
security: [{
|
|
29094
|
+
key: "devops-bearerAuth",
|
|
29095
|
+
scheme: "bearer",
|
|
29096
|
+
type: "http"
|
|
29097
|
+
}],
|
|
29098
|
+
url: "/devops/v1/projects/{project}/test-runs",
|
|
29099
|
+
...options
|
|
29100
|
+
});
|
|
29101
|
+
var devopsTestRunsCreate = (options) => (options.client ?? client).post({
|
|
29102
|
+
security: [{
|
|
29103
|
+
key: "devops-bearerAuth",
|
|
29104
|
+
scheme: "bearer",
|
|
29105
|
+
type: "http"
|
|
29106
|
+
}],
|
|
29107
|
+
url: "/devops/v1/projects/{project}/test-runs",
|
|
29108
|
+
...options,
|
|
29109
|
+
headers: {
|
|
29110
|
+
"Content-Type": "application/json",
|
|
29111
|
+
...options.headers
|
|
29112
|
+
}
|
|
29113
|
+
});
|
|
29114
|
+
var devopsTestRunsGet = (options) => (options.client ?? client).get({
|
|
29115
|
+
security: [{
|
|
29116
|
+
key: "devops-bearerAuth",
|
|
29117
|
+
scheme: "bearer",
|
|
29118
|
+
type: "http"
|
|
29119
|
+
}],
|
|
29120
|
+
url: "/devops/v1/test-runs/{id}",
|
|
29121
|
+
...options
|
|
29122
|
+
});
|
|
29123
|
+
var devopsTestRunsCancel = (options) => (options.client ?? client).post({
|
|
29124
|
+
security: [{
|
|
29125
|
+
key: "devops-bearerAuth",
|
|
29126
|
+
scheme: "bearer",
|
|
29127
|
+
type: "http"
|
|
29128
|
+
}],
|
|
29129
|
+
url: "/devops/v1/test-runs/{id}:cancel",
|
|
29130
|
+
...options,
|
|
29131
|
+
headers: {
|
|
29132
|
+
"Content-Type": "application/json",
|
|
29133
|
+
...options.headers
|
|
29134
|
+
}
|
|
29135
|
+
});
|
|
29136
|
+
var devopsTestExecutionsList = (options) => (options.client ?? client).get({
|
|
29137
|
+
security: [{
|
|
29138
|
+
key: "devops-bearerAuth",
|
|
29139
|
+
scheme: "bearer",
|
|
29140
|
+
type: "http"
|
|
29141
|
+
}],
|
|
29142
|
+
url: "/devops/v1/test-runs/{run}/executions",
|
|
29143
|
+
...options
|
|
29144
|
+
});
|
|
29145
|
+
var devopsTestExecutionsGet = (options) => (options.client ?? client).get({
|
|
29146
|
+
security: [{
|
|
29147
|
+
key: "devops-bearerAuth",
|
|
29148
|
+
scheme: "bearer",
|
|
29149
|
+
type: "http"
|
|
29150
|
+
}],
|
|
29151
|
+
url: "/devops/v1/test-runs/{run}/executions/{case}",
|
|
29152
|
+
...options
|
|
29153
|
+
});
|
|
29154
|
+
var devopsTestReportsUpload = (options) => (options.client ?? client).post({
|
|
29155
|
+
security: [{
|
|
29156
|
+
key: "devops-bearerAuth",
|
|
29157
|
+
scheme: "bearer",
|
|
29158
|
+
type: "http"
|
|
29159
|
+
}],
|
|
29160
|
+
url: "/devops/v1/projects/{project}/test-reports",
|
|
29161
|
+
...options,
|
|
29162
|
+
headers: {
|
|
29163
|
+
"Content-Type": "application/json",
|
|
29164
|
+
...options.headers
|
|
29165
|
+
}
|
|
29166
|
+
});
|
|
27409
29167
|
var knowledgeListVectorStores = (options) => (options?.client ?? client).get({
|
|
27410
29168
|
security: [{
|
|
27411
29169
|
key: "knowledge-bearerAuth",
|
|
@@ -27998,6 +29756,164 @@ var mediaGetGenerationCapabilities = (options) => (options?.client ?? client).ge
|
|
|
27998
29756
|
url: "/media/v1/generation/capabilities",
|
|
27999
29757
|
...options
|
|
28000
29758
|
});
|
|
29759
|
+
var ontologyListTypes = (options) => (options?.client ?? client).get({
|
|
29760
|
+
security: [{
|
|
29761
|
+
key: "ontology-bearerAuth",
|
|
29762
|
+
scheme: "bearer",
|
|
29763
|
+
type: "http"
|
|
29764
|
+
}],
|
|
29765
|
+
url: "/ontology/v1/types",
|
|
29766
|
+
...options
|
|
29767
|
+
});
|
|
29768
|
+
var ontologyRegisterType = (options) => (options.client ?? client).post({
|
|
29769
|
+
security: [{
|
|
29770
|
+
key: "ontology-bearerAuth",
|
|
29771
|
+
scheme: "bearer",
|
|
29772
|
+
type: "http"
|
|
29773
|
+
}],
|
|
29774
|
+
url: "/ontology/v1/types",
|
|
29775
|
+
...options,
|
|
29776
|
+
headers: {
|
|
29777
|
+
"Content-Type": "application/json",
|
|
29778
|
+
...options.headers
|
|
29779
|
+
}
|
|
29780
|
+
});
|
|
29781
|
+
var ontologyRetrieveType = (options) => (options.client ?? client).get({
|
|
29782
|
+
security: [{
|
|
29783
|
+
key: "ontology-bearerAuth",
|
|
29784
|
+
scheme: "bearer",
|
|
29785
|
+
type: "http"
|
|
29786
|
+
}],
|
|
29787
|
+
url: "/ontology/v1/types/{name}",
|
|
29788
|
+
...options
|
|
29789
|
+
});
|
|
29790
|
+
var ontologyListNodes = (options) => (options?.client ?? client).get({
|
|
29791
|
+
security: [{
|
|
29792
|
+
key: "ontology-bearerAuth",
|
|
29793
|
+
scheme: "bearer",
|
|
29794
|
+
type: "http"
|
|
29795
|
+
}],
|
|
29796
|
+
url: "/ontology/v1/nodes",
|
|
29797
|
+
...options
|
|
29798
|
+
});
|
|
29799
|
+
var ontologyCreateNode = (options) => (options.client ?? client).post({
|
|
29800
|
+
security: [{
|
|
29801
|
+
key: "ontology-bearerAuth",
|
|
29802
|
+
scheme: "bearer",
|
|
29803
|
+
type: "http"
|
|
29804
|
+
}],
|
|
29805
|
+
url: "/ontology/v1/nodes",
|
|
29806
|
+
...options,
|
|
29807
|
+
headers: {
|
|
29808
|
+
"Content-Type": "application/json",
|
|
29809
|
+
...options.headers
|
|
29810
|
+
}
|
|
29811
|
+
});
|
|
29812
|
+
var ontologyRetrieveNode = (options) => (options.client ?? client).get({
|
|
29813
|
+
security: [{
|
|
29814
|
+
key: "ontology-bearerAuth",
|
|
29815
|
+
scheme: "bearer",
|
|
29816
|
+
type: "http"
|
|
29817
|
+
}],
|
|
29818
|
+
url: "/ontology/v1/nodes/{node_id}",
|
|
29819
|
+
...options
|
|
29820
|
+
});
|
|
29821
|
+
var ontologyUpdateNode = (options) => (options.client ?? client).patch({
|
|
29822
|
+
security: [{
|
|
29823
|
+
key: "ontology-bearerAuth",
|
|
29824
|
+
scheme: "bearer",
|
|
29825
|
+
type: "http"
|
|
29826
|
+
}],
|
|
29827
|
+
url: "/ontology/v1/nodes/{node_id}",
|
|
29828
|
+
...options,
|
|
29829
|
+
headers: {
|
|
29830
|
+
"Content-Type": "application/json",
|
|
29831
|
+
...options.headers
|
|
29832
|
+
}
|
|
29833
|
+
});
|
|
29834
|
+
var ontologyMergeNode = (options) => (options.client ?? client).post({
|
|
29835
|
+
security: [{
|
|
29836
|
+
key: "ontology-bearerAuth",
|
|
29837
|
+
scheme: "bearer",
|
|
29838
|
+
type: "http"
|
|
29839
|
+
}],
|
|
29840
|
+
url: "/ontology/v1/nodes/{node_id}/merge",
|
|
29841
|
+
...options,
|
|
29842
|
+
headers: {
|
|
29843
|
+
"Content-Type": "application/json",
|
|
29844
|
+
...options.headers
|
|
29845
|
+
}
|
|
29846
|
+
});
|
|
29847
|
+
var ontologyListRelations = (options) => (options?.client ?? client).get({
|
|
29848
|
+
security: [{
|
|
29849
|
+
key: "ontology-bearerAuth",
|
|
29850
|
+
scheme: "bearer",
|
|
29851
|
+
type: "http"
|
|
29852
|
+
}],
|
|
29853
|
+
url: "/ontology/v1/relations",
|
|
29854
|
+
...options
|
|
29855
|
+
});
|
|
29856
|
+
var ontologyCreateRelation = (options) => (options.client ?? client).post({
|
|
29857
|
+
security: [{
|
|
29858
|
+
key: "ontology-bearerAuth",
|
|
29859
|
+
scheme: "bearer",
|
|
29860
|
+
type: "http"
|
|
29861
|
+
}],
|
|
29862
|
+
url: "/ontology/v1/relations",
|
|
29863
|
+
...options,
|
|
29864
|
+
headers: {
|
|
29865
|
+
"Content-Type": "application/json",
|
|
29866
|
+
...options.headers
|
|
29867
|
+
}
|
|
29868
|
+
});
|
|
29869
|
+
var ontologyRetrieveRelation = (options) => (options.client ?? client).get({
|
|
29870
|
+
security: [{
|
|
29871
|
+
key: "ontology-bearerAuth",
|
|
29872
|
+
scheme: "bearer",
|
|
29873
|
+
type: "http"
|
|
29874
|
+
}],
|
|
29875
|
+
url: "/ontology/v1/relations/{relation_id}",
|
|
29876
|
+
...options
|
|
29877
|
+
});
|
|
29878
|
+
var ontologyInvalidateRelation = (options) => (options.client ?? client).post({
|
|
29879
|
+
security: [{
|
|
29880
|
+
key: "ontology-bearerAuth",
|
|
29881
|
+
scheme: "bearer",
|
|
29882
|
+
type: "http"
|
|
29883
|
+
}],
|
|
29884
|
+
url: "/ontology/v1/relations/{relation_id}/invalidate",
|
|
29885
|
+
...options,
|
|
29886
|
+
headers: {
|
|
29887
|
+
"Content-Type": "application/json",
|
|
29888
|
+
...options.headers
|
|
29889
|
+
}
|
|
29890
|
+
});
|
|
29891
|
+
var ontologyApplyChangeset = (options) => (options.client ?? client).post({
|
|
29892
|
+
security: [{
|
|
29893
|
+
key: "ontology-bearerAuth",
|
|
29894
|
+
scheme: "bearer",
|
|
29895
|
+
type: "http"
|
|
29896
|
+
}],
|
|
29897
|
+
url: "/ontology/v1/changesets",
|
|
29898
|
+
...options,
|
|
29899
|
+
headers: {
|
|
29900
|
+
"Content-Type": "application/json",
|
|
29901
|
+
...options.headers
|
|
29902
|
+
}
|
|
29903
|
+
});
|
|
29904
|
+
var ontologySearch = (options) => (options.client ?? client).post({
|
|
29905
|
+
security: [{
|
|
29906
|
+
key: "ontology-bearerAuth",
|
|
29907
|
+
scheme: "bearer",
|
|
29908
|
+
type: "http"
|
|
29909
|
+
}],
|
|
29910
|
+
url: "/ontology/v1/search",
|
|
29911
|
+
...options,
|
|
29912
|
+
headers: {
|
|
29913
|
+
"Content-Type": "application/json",
|
|
29914
|
+
...options.headers
|
|
29915
|
+
}
|
|
29916
|
+
});
|
|
28001
29917
|
var getSandboxV1Sandboxes = (options) => (options?.client ?? client).get({
|
|
28002
29918
|
querySerializer: { parameters: { state: { array: { explode: false } } } },
|
|
28003
29919
|
security: [
|
|
@@ -29875,6 +31791,9 @@ function createAgent(transport) {
|
|
|
29875
31791
|
create: bind(transport, computersCreate),
|
|
29876
31792
|
delete: bind(transport, computersDelete),
|
|
29877
31793
|
files: {
|
|
31794
|
+
convert: {
|
|
31795
|
+
create: bind(transport, computersFilesConvert)
|
|
31796
|
+
},
|
|
29878
31797
|
list: bind(transport, computersFilesList),
|
|
29879
31798
|
retrieveContent: bind(transport, computersFilesContent)
|
|
29880
31799
|
},
|
|
@@ -30322,6 +32241,9 @@ function createCut(transport) {
|
|
|
30322
32241
|
media: {
|
|
30323
32242
|
import: bind(transport, cutImportMedia)
|
|
30324
32243
|
},
|
|
32244
|
+
renders: {
|
|
32245
|
+
create: bind(transport, cutCreateRender)
|
|
32246
|
+
},
|
|
30325
32247
|
retrieve: bind(transport, cutRetrieveProject),
|
|
30326
32248
|
retrieveState: bind(transport, cutRetrieveState),
|
|
30327
32249
|
retrieveTimeline: bind(transport, cutRetrieveTimeline),
|
|
@@ -30332,6 +32254,9 @@ function createCut(transport) {
|
|
|
30332
32254
|
list: bind(transport, cutListVersions)
|
|
30333
32255
|
}
|
|
30334
32256
|
},
|
|
32257
|
+
renders: {
|
|
32258
|
+
retrieve: bind(transport, cutRetrieveRender)
|
|
32259
|
+
},
|
|
30335
32260
|
versions: {
|
|
30336
32261
|
restore: bind(transport, cutRestoreVersion)
|
|
30337
32262
|
}
|
|
@@ -30374,6 +32299,51 @@ function createDatabase(transport) {
|
|
|
30374
32299
|
}
|
|
30375
32300
|
};
|
|
30376
32301
|
}
|
|
32302
|
+
function createDevops(transport) {
|
|
32303
|
+
return {
|
|
32304
|
+
projects: {
|
|
32305
|
+
retrieveTestCatalog: bind(transport, devopsTestCatalogGet),
|
|
32306
|
+
testCases: {
|
|
32307
|
+
list: bind(transport, devopsTestCasesList)
|
|
32308
|
+
},
|
|
32309
|
+
testPlans: {
|
|
32310
|
+
create: bind(transport, devopsTestPlansCreate),
|
|
32311
|
+
list: bind(transport, devopsTestPlansList)
|
|
32312
|
+
},
|
|
32313
|
+
testReports: {
|
|
32314
|
+
create: bind(transport, devopsTestReportsUpload)
|
|
32315
|
+
},
|
|
32316
|
+
testRuns: {
|
|
32317
|
+
create: bind(transport, devopsTestRunsCreate),
|
|
32318
|
+
list: bind(transport, devopsTestRunsList)
|
|
32319
|
+
},
|
|
32320
|
+
testSuites: {
|
|
32321
|
+
list: bind(transport, devopsTestSuitesList)
|
|
32322
|
+
}
|
|
32323
|
+
},
|
|
32324
|
+
testCases: {
|
|
32325
|
+
retrieve: bind(transport, devopsTestCasesGet)
|
|
32326
|
+
},
|
|
32327
|
+
testPlans: {
|
|
32328
|
+
delete: bind(transport, devopsTestPlansDelete),
|
|
32329
|
+
pause: bind(transport, devopsTestPlansPause),
|
|
32330
|
+
resume: bind(transport, devopsTestPlansResume),
|
|
32331
|
+
retrieve: bind(transport, devopsTestPlansGet),
|
|
32332
|
+
update: bind(transport, devopsTestPlansUpdate)
|
|
32333
|
+
},
|
|
32334
|
+
testRuns: {
|
|
32335
|
+
cancel: bind(transport, devopsTestRunsCancel),
|
|
32336
|
+
executions: {
|
|
32337
|
+
list: bind(transport, devopsTestExecutionsList),
|
|
32338
|
+
retrieve: bind(transport, devopsTestExecutionsGet)
|
|
32339
|
+
},
|
|
32340
|
+
retrieve: bind(transport, devopsTestRunsGet)
|
|
32341
|
+
},
|
|
32342
|
+
testSuites: {
|
|
32343
|
+
retrieve: bind(transport, devopsTestSuitesGet)
|
|
32344
|
+
}
|
|
32345
|
+
};
|
|
32346
|
+
}
|
|
30377
32347
|
function createFile(transport) {
|
|
30378
32348
|
return {
|
|
30379
32349
|
files: {
|
|
@@ -30396,7 +32366,8 @@ function createFile(transport) {
|
|
|
30396
32366
|
createSigned: bind(transport, fileCreateSignedUpload),
|
|
30397
32367
|
parts: {
|
|
30398
32368
|
create: bind(transport, (options) => fileAddUploadPart({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } }))
|
|
30399
|
-
}
|
|
32369
|
+
},
|
|
32370
|
+
retrieve: bind(transport, fileRetrieveUpload)
|
|
30400
32371
|
}
|
|
30401
32372
|
};
|
|
30402
32373
|
}
|
|
@@ -30624,6 +32595,38 @@ function createModel(transport) {
|
|
|
30624
32595
|
}
|
|
30625
32596
|
};
|
|
30626
32597
|
}
|
|
32598
|
+
function createOntology(transport) {
|
|
32599
|
+
return {
|
|
32600
|
+
changesets: {
|
|
32601
|
+
create: bind(transport, ontologyApplyChangeset)
|
|
32602
|
+
},
|
|
32603
|
+
nodes: {
|
|
32604
|
+
create: bind(transport, ontologyCreateNode),
|
|
32605
|
+
list: bindPage(transport, ontologyListNodes),
|
|
32606
|
+
merge: {
|
|
32607
|
+
create: bind(transport, ontologyMergeNode)
|
|
32608
|
+
},
|
|
32609
|
+
retrieve: bind(transport, ontologyRetrieveNode),
|
|
32610
|
+
update: bind(transport, ontologyUpdateNode)
|
|
32611
|
+
},
|
|
32612
|
+
relations: {
|
|
32613
|
+
create: bind(transport, ontologyCreateRelation),
|
|
32614
|
+
invalidate: {
|
|
32615
|
+
create: bind(transport, ontologyInvalidateRelation)
|
|
32616
|
+
},
|
|
32617
|
+
list: bindPage(transport, ontologyListRelations),
|
|
32618
|
+
retrieve: bind(transport, ontologyRetrieveRelation)
|
|
32619
|
+
},
|
|
32620
|
+
search: {
|
|
32621
|
+
create: bind(transport, ontologySearch)
|
|
32622
|
+
},
|
|
32623
|
+
types: {
|
|
32624
|
+
create: bind(transport, ontologyRegisterType),
|
|
32625
|
+
list: bind(transport, ontologyListTypes),
|
|
32626
|
+
retrieve: bind(transport, ontologyRetrieveType)
|
|
32627
|
+
}
|
|
32628
|
+
};
|
|
32629
|
+
}
|
|
30627
32630
|
function createOrganization(transport) {
|
|
30628
32631
|
return {
|
|
30629
32632
|
charges: {
|
|
@@ -30885,11 +32888,13 @@ var resourceFactories = {
|
|
|
30885
32888
|
crm: createCrm,
|
|
30886
32889
|
cut: createCut,
|
|
30887
32890
|
database: createDatabase,
|
|
32891
|
+
devops: createDevops,
|
|
30888
32892
|
file: createFile,
|
|
30889
32893
|
knowledge: createKnowledge,
|
|
30890
32894
|
media: createMedia,
|
|
30891
32895
|
meta: createMeta,
|
|
30892
32896
|
model: createModel,
|
|
32897
|
+
ontology: createOntology,
|
|
30893
32898
|
organization: createOrganization,
|
|
30894
32899
|
sandbox: createSandbox,
|
|
30895
32900
|
search: createSearch,
|
|
@@ -31963,6 +33968,26 @@ async function prepareMultipart(op, opts) {
|
|
|
31963
33968
|
opts.body = body;
|
|
31964
33969
|
}
|
|
31965
33970
|
|
|
33971
|
+
// src/core/pagination.ts
|
|
33972
|
+
var PAGE_TOKENS = /^(page_?token|next_?page_?token)$/i;
|
|
33973
|
+
function pageTokenField(op) {
|
|
33974
|
+
return op.query.find((field) => PAGE_TOKENS.test(field.name));
|
|
33975
|
+
}
|
|
33976
|
+
function nextPageToken(result) {
|
|
33977
|
+
const value = result;
|
|
33978
|
+
const token = value?.next_page_token ?? value?.nextPageToken ?? value?.next_cursor;
|
|
33979
|
+
return typeof token === "string" && token ? token : undefined;
|
|
33980
|
+
}
|
|
33981
|
+
function pageOf(result) {
|
|
33982
|
+
const value = result;
|
|
33983
|
+
const arrays = value && typeof value === "object" ? Object.values(value).filter(Array.isArray) : [];
|
|
33984
|
+
const data = Array.isArray(value?.data) ? value.data : Array.isArray(value?.items) ? value.items : arrays.length === 1 ? arrays[0] : undefined;
|
|
33985
|
+
if (!Array.isArray(data))
|
|
33986
|
+
return;
|
|
33987
|
+
const token = nextPageToken(result);
|
|
33988
|
+
return { items: data, ...token ? { token } : {} };
|
|
33989
|
+
}
|
|
33990
|
+
|
|
31966
33991
|
// src/core/bind-args.ts
|
|
31967
33992
|
var globalOptions = [
|
|
31968
33993
|
{ name: "org", type: "string" },
|
|
@@ -32178,7 +34203,7 @@ function bindArgs(parsed, op, data) {
|
|
|
32178
34203
|
(opts.query ??= {})[key] ??= convert(String(globals[name]), { name, type: field.type, enum: field.enum });
|
|
32179
34204
|
}
|
|
32180
34205
|
}
|
|
32181
|
-
if (globals.all && !op.pagination)
|
|
34206
|
+
if (globals.all && !op.pagination && !pageTokenField(op))
|
|
32182
34207
|
throw new UsageError("--all requires a paginated operation");
|
|
32183
34208
|
for (const p of op.pathParams)
|
|
32184
34209
|
if (p !== target && opts.path?.[p.sdkName] === undefined)
|
|
@@ -32204,8 +34229,8 @@ function bindArgs(parsed, op, data) {
|
|
|
32204
34229
|
}
|
|
32205
34230
|
|
|
32206
34231
|
// src/core/help.ts
|
|
32207
|
-
function describeOption(s) {
|
|
32208
|
-
return `--${s.name}${s.type === "boolean" ? " [true|false]" : ` <${s.type}>`}${s.repeated ? " (repeatable)" : ""}${
|
|
34232
|
+
function describeOption(s, required = s.required) {
|
|
34233
|
+
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, " ")}` : ""}`;
|
|
32209
34234
|
}
|
|
32210
34235
|
function example(command) {
|
|
32211
34236
|
const target = targetParam(command.op);
|
|
@@ -32221,18 +34246,22 @@ function example(command) {
|
|
|
32221
34246
|
args.push("--yes");
|
|
32222
34247
|
return args.join(" ");
|
|
32223
34248
|
}
|
|
34249
|
+
function fieldRequired(op, field, location) {
|
|
34250
|
+
return Boolean(field.required) && (location === "path" || location === "query" || Boolean(op.body?.required));
|
|
34251
|
+
}
|
|
32224
34252
|
function help(commands, prefix, command) {
|
|
32225
34253
|
if (command) {
|
|
32226
34254
|
const target = targetParam(command.op);
|
|
34255
|
+
const parents = operationOptions(command.op).filter((s) => s.location === "path" && s.required).map((s) => ` --${s.name} <${s.field?.name ?? s.sdkName}>`).join("");
|
|
32227
34256
|
return [
|
|
32228
|
-
`praxis ${command.words.join(" ")}${target ? ` <${target.sdkName}>` : ""} [options]`,
|
|
34257
|
+
`praxis ${command.words.join(" ")}${parents}${target ? ` <${target.sdkName}>` : ""} [options]`,
|
|
32229
34258
|
`SDK: ${command.op.resource}.${command.alias ?? command.op.method}`,
|
|
32230
34259
|
`${command.op.http} ${command.op.path}`,
|
|
32231
34260
|
...target ? [`Position: <${target.sdkName}>${target.type ? ` <${target.type}>` : ""} (required target ID)`] : [],
|
|
32232
34261
|
"",
|
|
32233
34262
|
"Options:",
|
|
32234
34263
|
...target?.description ? [` <${target.sdkName}> — ${target.description.replace(/\s+/g, " ")}`] : [],
|
|
32235
|
-
...[...operationOptions(command.op), ...bodyDataOption(command.op), ...globalOptions].map((s) => ` ${describeOption(s)}`),
|
|
34264
|
+
...[...operationOptions(command.op), ...bodyDataOption(command.op), ...globalOptions].map((s) => ` ${describeOption(s, s.required && fieldRequired(command.op, s, s.location ?? "query"))}`),
|
|
32236
34265
|
...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" : ""})`) ?? [],
|
|
32237
34266
|
" -h is an alias of --help",
|
|
32238
34267
|
"PRAXIS_ENV=develop|production (default: develop); no --env option.",
|
|
@@ -32300,6 +34329,7 @@ var workflows = [
|
|
|
32300
34329
|
{ words: ["app", "create"], usage: "app create <name> [--dir <path>] [--template <dir>] [--no-install]", summary: "Create an application project from the standard template and install its dependencies.", example: "praxis app create my-app" },
|
|
32301
34330
|
{ words: ["app", "deploy"], usage: "app deploy [--dir <path>] [--no-build]", summary: "Build the project, publish it, create declared secrets, run the health check and print the URL.", example: "praxis app deploy --dir ./my-app" },
|
|
32302
34331
|
{ words: ["app", "rollback"], usage: "app rollback [--dir <path>] [--to <version_id>]", summary: "Deploy the previous version again (or --to a given version) and wait until it is active.", example: "praxis app rollback --to <version_id>" },
|
|
34332
|
+
{ words: ["devops", "test", "run"], usage: "devops test run --remote [--project <dvp_…>] [--no-wait] [--repeat <n>] [--select <kind:value>]", summary: "Run the DevOps test selection for the pushed HEAD on the Praxis cloud, wait for the verdict and list the failed cases.", example: "praxis devops test run --remote --select smoke" },
|
|
32303
34333
|
{ words: ["skill"], usage: "skill [--install <dir>]", summary: "Print the AI skill, or write <dir>/praxis-cli/SKILL.md." }
|
|
32304
34334
|
];
|
|
32305
34335
|
var workflowNouns = [...new Set(workflows.filter((w) => w.words.length > 1).map((w) => w.words[0]))];
|
|
@@ -32756,7 +34786,18 @@ function skillDocument(commands) {
|
|
|
32756
34786
|
"## Account and CLI",
|
|
32757
34787
|
"",
|
|
32758
34788
|
...workflows.map((w) => `praxis ${w.usage} — ${w.summary.replace("Print the AI skill, or write", "Print this skill; use --install <dir> to write")}`),
|
|
32759
|
-
"praxis api <METHOD> <path> — Call an API path directly. (--data for a request body)"
|
|
34789
|
+
"praxis api <METHOD> <path> — Call an API path directly. (--data for a request body)",
|
|
34790
|
+
"",
|
|
34791
|
+
"## devops test run (workflow)",
|
|
34792
|
+
"",
|
|
34793
|
+
"Run the project's tests at the commit HEAD is on, on the Praxis cloud executor, and wait for the verdict:",
|
|
34794
|
+
"",
|
|
34795
|
+
"- Only the pushed commit is tested. HEAD must be on a remote branch (`git push` first); this command never pushes for you. Uncommitted changes are a warning only — the working tree is not what runs.",
|
|
34796
|
+
"- The project comes from `--project dvp_…`, or from `devops.project` in the current directory's praxis.jsonc. Neither present is a usage error, exit code 2.",
|
|
34797
|
+
"- `--select` narrows the run: `tag:<tag>` (a bare word reads as a tag), `package:<path>`, `suite:<path>`, `file:<path>`. `--repeat N` runs each selected case N times (a flake then shows up as flaky, not as a failure).",
|
|
34798
|
+
"- The run waits by default and polls every 5s; `--no-wait` returns as soon as the run exists, with `result` still `pending`.",
|
|
34799
|
+
"- Exit code 0 means the verdict passed (or is still pending); 1 means failed, errored, cancelled or timed out — the failed cases are listed, up to 20, with the run URL for the rest; 2 is a usage error.",
|
|
34800
|
+
"- The run URL is on the Console of the environment the CLI talks to; the run id is also on stdout with `--json`."
|
|
32760
34801
|
];
|
|
32761
34802
|
let domain;
|
|
32762
34803
|
for (const command of commands) {
|
|
@@ -33302,6 +35343,191 @@ async function appRollback(args, client2, ports) {
|
|
|
33302
35343
|
ports.emit({ kind: "object", data: { url: worker.subdomain?.url ?? null, worker_id: worker.id, from_version: from, to_version: to, deployment_id: done.id } });
|
|
33303
35344
|
}
|
|
33304
35345
|
|
|
35346
|
+
// src/commands/devops.ts
|
|
35347
|
+
import { join as join4 } from "node:path";
|
|
35348
|
+
|
|
35349
|
+
// src/devops/pure.ts
|
|
35350
|
+
import { createHash as createHash2 } from "node:crypto";
|
|
35351
|
+
var PROJECT_ID = /^dvp_[a-z0-9]+$/;
|
|
35352
|
+
var POLL_MS = 5000;
|
|
35353
|
+
var FAILURE_LIMIT = 20;
|
|
35354
|
+
var hint = 'Pass --project dvp_…, or add "devops": { "project": "dvp_…" } to praxis.jsonc in the current directory.';
|
|
35355
|
+
function checkProject(value, hintText = hint) {
|
|
35356
|
+
if (typeof value !== "string" || !value.trim())
|
|
35357
|
+
throw new UsageError("A DevOps project id must be a non-empty string", hintText);
|
|
35358
|
+
if (!PROJECT_ID.test(value.trim()))
|
|
35359
|
+
throw new UsageError(`Not a DevOps project id: ${value}`, "A project id starts with dvp_ and comes from the project list. " + hintText);
|
|
35360
|
+
return value.trim();
|
|
35361
|
+
}
|
|
35362
|
+
function parseDevopsProject(value) {
|
|
35363
|
+
if (value === null || value === undefined || typeof value !== "object" || Array.isArray(value))
|
|
35364
|
+
return;
|
|
35365
|
+
const devops = value.devops;
|
|
35366
|
+
if (devops === undefined)
|
|
35367
|
+
return;
|
|
35368
|
+
if (devops === null || typeof devops !== "object" || Array.isArray(devops))
|
|
35369
|
+
throw new UsageError("praxis.jsonc devops must be an object", 'Write {"devops":{"project":"dvp_…"}}. ' + hint);
|
|
35370
|
+
const project = devops.project;
|
|
35371
|
+
if (project === undefined)
|
|
35372
|
+
return;
|
|
35373
|
+
return checkProject(project);
|
|
35374
|
+
}
|
|
35375
|
+
function resolveProject(flag, projectFile) {
|
|
35376
|
+
if (flag !== undefined)
|
|
35377
|
+
return checkProject(flag);
|
|
35378
|
+
const fromFile = parseDevopsProject(projectFile);
|
|
35379
|
+
if (fromFile !== undefined)
|
|
35380
|
+
return fromFile;
|
|
35381
|
+
throw new UsageError("No DevOps project named for this run", hint);
|
|
35382
|
+
}
|
|
35383
|
+
var sorted = (values) => [...values].sort();
|
|
35384
|
+
var SELECT_KINDS = { tag: "anyTags", package: "packages", suite: "packages", file: "packages" };
|
|
35385
|
+
function parseSelect(values) {
|
|
35386
|
+
if (!values.length)
|
|
35387
|
+
return;
|
|
35388
|
+
const tags = [], packages = [];
|
|
35389
|
+
for (const raw of values) {
|
|
35390
|
+
const at = raw.indexOf(":");
|
|
35391
|
+
const kind = at < 0 ? "tag" : raw.slice(0, at).trim().toLowerCase();
|
|
35392
|
+
const value = (at < 0 ? raw : raw.slice(at + 1)).trim();
|
|
35393
|
+
const kinds = Object.keys(SELECT_KINDS).join(", ");
|
|
35394
|
+
if (!value)
|
|
35395
|
+
throw new UsageError(`--select ${raw} names no value`, `Use --select <kind>:<value>, or a bare tag name; kinds are ${kinds}.`);
|
|
35396
|
+
if (!Object.hasOwn(SELECT_KINDS, kind))
|
|
35397
|
+
throw new UsageError(`--select ${raw}: unknown kind "${kind}"`, `Use one of: ${kinds}.`);
|
|
35398
|
+
(SELECT_KINDS[kind] === "anyTags" ? tags : packages).push(value);
|
|
35399
|
+
}
|
|
35400
|
+
return { ...tags.length ? { anyTags: sorted(tags) } : {}, ...packages.length ? { packages: sorted(packages) } : {} };
|
|
35401
|
+
}
|
|
35402
|
+
function parseRepeat(value) {
|
|
35403
|
+
if (value === undefined)
|
|
35404
|
+
return 1;
|
|
35405
|
+
const n = typeof value === "string" && value.trim() ? Number(value) : NaN;
|
|
35406
|
+
if (!Number.isSafeInteger(n) || n < 1)
|
|
35407
|
+
throw new UsageError("--repeat must be an integer of at least 1");
|
|
35408
|
+
return n;
|
|
35409
|
+
}
|
|
35410
|
+
function requireRemote(remote) {
|
|
35411
|
+
if (!remote)
|
|
35412
|
+
throw new UsageError("Only remote test runs are available", "Add --remote to run the selected cases on the Praxis cloud executor.");
|
|
35413
|
+
}
|
|
35414
|
+
function requestIdFor(input) {
|
|
35415
|
+
const selector = input.selector === undefined ? null : {
|
|
35416
|
+
sizes: sorted(input.selector.sizes ?? []),
|
|
35417
|
+
anyTags: sorted(input.selector.anyTags ?? []),
|
|
35418
|
+
packages: sorted(input.selector.packages ?? []),
|
|
35419
|
+
cases: sorted(input.selector.cases ?? [])
|
|
35420
|
+
};
|
|
35421
|
+
const material = JSON.stringify(["devops-test-run", input.project, input.commit, input.repeat, selector]);
|
|
35422
|
+
return `req_${createHash2("sha256").update(material).digest("hex").slice(0, 32)}`;
|
|
35423
|
+
}
|
|
35424
|
+
var isTerminal = (state) => state === "finished";
|
|
35425
|
+
function shortSha(commit) {
|
|
35426
|
+
return commit.slice(0, 7);
|
|
35427
|
+
}
|
|
35428
|
+
function headBranch(output) {
|
|
35429
|
+
const name = output.trim();
|
|
35430
|
+
return !name || name === "HEAD" ? undefined : name;
|
|
35431
|
+
}
|
|
35432
|
+
function requirePushed(remoteContains, commit, branch) {
|
|
35433
|
+
if (remoteContains.trim())
|
|
35434
|
+
return;
|
|
35435
|
+
throw new UsageError(`Commit ${shortSha(commit)}${branch ? ` on ${branch}` : ""} is not on any remote branch`, `Push it first (git push${branch ? ` origin ${branch}` : ""}); the run tests the pushed commit, and this command never pushes for you.`);
|
|
35436
|
+
}
|
|
35437
|
+
function dirtyNotice(status, commit) {
|
|
35438
|
+
const files = status.split(`
|
|
35439
|
+
`).filter((line) => line.trim()).length;
|
|
35440
|
+
if (files === 0)
|
|
35441
|
+
return;
|
|
35442
|
+
return `Warning: ${files} uncommitted change${files === 1 ? "" : "s"}; the run tests the pushed commit ${shortSha(commit)}, not this working tree.`;
|
|
35443
|
+
}
|
|
35444
|
+
function exitCodeFor(result) {
|
|
35445
|
+
return result === "passed" || result === "pending" ? 0 : 1;
|
|
35446
|
+
}
|
|
35447
|
+
var wantsFailures = (result) => result !== "passed" && result !== "pending";
|
|
35448
|
+
function failedList(items, nextPageToken2, url) {
|
|
35449
|
+
const shown = items.slice(0, FAILURE_LIMIT);
|
|
35450
|
+
if (items.length <= FAILURE_LIMIT && !nextPageToken2)
|
|
35451
|
+
return { shown };
|
|
35452
|
+
return { shown, hint: `Showing ${FAILURE_LIMIT} of the failed cases; the run page lists them all: ${url}` };
|
|
35453
|
+
}
|
|
35454
|
+
var CONSOLE = { develop: "https://console-develop.deepraxis.com", production: "https://console.deepraxis.com" };
|
|
35455
|
+
function runUrl(env, project, id, viewerUrl) {
|
|
35456
|
+
return viewerUrl?.trim() || `${CONSOLE[env]}/devops/projects/${project}/test-runs/${id}`;
|
|
35457
|
+
}
|
|
35458
|
+
|
|
35459
|
+
// src/commands/devops.ts
|
|
35460
|
+
async function projectFile(cwd, ports) {
|
|
35461
|
+
let text;
|
|
35462
|
+
try {
|
|
35463
|
+
text = await ports.readFile(join4(cwd, "praxis.jsonc"));
|
|
35464
|
+
} catch (error) {
|
|
35465
|
+
if (error.code === "ENOENT")
|
|
35466
|
+
return;
|
|
35467
|
+
throw error;
|
|
35468
|
+
}
|
|
35469
|
+
try {
|
|
35470
|
+
return parseJsonc(text);
|
|
35471
|
+
} catch (error) {
|
|
35472
|
+
throw new UsageError(`praxis.jsonc is not valid JSONC: ${error.message}`);
|
|
35473
|
+
}
|
|
35474
|
+
}
|
|
35475
|
+
var COUNT_ORDER = ["passed", "failed", "flaky", "skipped", "pending", "other"];
|
|
35476
|
+
var countLine = (counts) => COUNT_ORDER.filter((key) => counts?.[key]).map((key) => `${counts[key]} ${key}`).join(", ") || "no counts reported";
|
|
35477
|
+
async function devopsTestRun(args, connect, env, ports) {
|
|
35478
|
+
requireRemote(args.remote);
|
|
35479
|
+
const project = resolveProject(args.project, await projectFile(ports.cwd, ports));
|
|
35480
|
+
const selector = parseSelect(args.select ?? []);
|
|
35481
|
+
const repeat = parseRepeat(args.repeat);
|
|
35482
|
+
const git = async (gitArgs) => (await ports.git(gitArgs, ports.cwd)).output;
|
|
35483
|
+
const commit = (await git(["rev-parse", "HEAD"])).trim();
|
|
35484
|
+
if (!commit)
|
|
35485
|
+
throw new UsageError("git rev-parse HEAD answered no commit", "Run this command inside a git repository.");
|
|
35486
|
+
const branch = headBranch(await git(["rev-parse", "--abbrev-ref", "HEAD"]));
|
|
35487
|
+
requirePushed(await git(["branch", "-r", "--contains", "HEAD"]), commit, branch);
|
|
35488
|
+
const notice = dirtyNotice(await git(["status", "--porcelain"]), commit);
|
|
35489
|
+
if (notice)
|
|
35490
|
+
ports.emit({ kind: "message", channel: "stderr", text: notice });
|
|
35491
|
+
const client2 = await connect();
|
|
35492
|
+
const requestId = requestIdFor({ project, commit, selector, repeat });
|
|
35493
|
+
let run = await client2.devops.projects.testRuns.create({ path: { project }, body: { ref: { ...branch ? { branch } : {}, commit }, ...selector ? { selector } : {}, repeat, executor: "cloud", requestId } });
|
|
35494
|
+
while (args.wait && !isTerminal(run.state)) {
|
|
35495
|
+
await ports.wait(POLL_MS);
|
|
35496
|
+
run = await client2.devops.testRuns.retrieve({ path: { id: run.id } });
|
|
35497
|
+
}
|
|
35498
|
+
const url = runUrl(env, project, run.id, run.viewerUrl);
|
|
35499
|
+
let failures = [], failureHint;
|
|
35500
|
+
if (wantsFailures(run.result)) {
|
|
35501
|
+
const page = await client2.devops.testRuns.executions.list({ path: { run: run.id }, query: { pageSize: FAILURE_LIMIT, filter: "result=failed" } });
|
|
35502
|
+
({ shown: failures, hint: failureHint } = failedList(page.items, page.nextPageToken, url));
|
|
35503
|
+
}
|
|
35504
|
+
const data = {
|
|
35505
|
+
id: run.id,
|
|
35506
|
+
url,
|
|
35507
|
+
project,
|
|
35508
|
+
state: run.state,
|
|
35509
|
+
result: run.result,
|
|
35510
|
+
repeat,
|
|
35511
|
+
commit,
|
|
35512
|
+
...branch ? { branch } : {},
|
|
35513
|
+
selected: run.selection?.selectedCount ?? null,
|
|
35514
|
+
counts: run.counts ?? null,
|
|
35515
|
+
request_id: requestId,
|
|
35516
|
+
failures: failures.map((execution) => ({ case: execution.case, title: execution.title, package: execution.package ?? null, status: execution.status })),
|
|
35517
|
+
...failureHint ? { failures_hint: failureHint } : {}
|
|
35518
|
+
};
|
|
35519
|
+
ports.emit({ kind: "object", data });
|
|
35520
|
+
ports.human([
|
|
35521
|
+
`${run.result} — ${project} @ ${commit.slice(0, 7)}${branch ? ` (${branch})` : ""}`,
|
|
35522
|
+
`state ${run.state}, ${countLine(run.counts)}`,
|
|
35523
|
+
url,
|
|
35524
|
+
...failures.map((execution) => ` failed ${execution.title}`),
|
|
35525
|
+
...failureHint ? [failureHint] : []
|
|
35526
|
+
].join(`
|
|
35527
|
+
`));
|
|
35528
|
+
return exitCodeFor(run.result);
|
|
35529
|
+
}
|
|
35530
|
+
|
|
33305
35531
|
// src/main.ts
|
|
33306
35532
|
import { spawnSync } from "node:child_process";
|
|
33307
35533
|
|
|
@@ -33600,9 +35826,11 @@ function renderHuman(result, ctx) {
|
|
|
33600
35826
|
const details = result.details !== undefined ? JSON.stringify(result.details) : undefined;
|
|
33601
35827
|
const detailsLine = details !== undefined ? ` details ${details.length > 2000 ? details.slice(0, 1999) + "…" : details}
|
|
33602
35828
|
` : "";
|
|
35829
|
+
const problemLine = problemLines(result.problem).map((line) => ` ${plain(line)}
|
|
35830
|
+
`).join("");
|
|
33603
35831
|
return { stderr: err.red(`✗ ${plain(result.message)}`) + `
|
|
33604
35832
|
` + err.dim(` code ${plain(result.code)}${result.status !== undefined ? ` · ${result.status}` : ""} · env ${plain(result.env)}${result.request_id ? ` · request ${plain(result.request_id)}` : ""}`) + `
|
|
33605
|
-
` + detailsLine + (result.hint ? ` → ${plain(result.hint)}
|
|
35833
|
+
` + detailsLine + problemLine + (result.hint ? ` → ${plain(result.hint)}
|
|
33606
35834
|
` : "") };
|
|
33607
35835
|
}
|
|
33608
35836
|
case "list":
|
|
@@ -33690,8 +35918,33 @@ ${usage ? `usage: ${JSON.stringify(usage)}
|
|
|
33690
35918
|
}
|
|
33691
35919
|
|
|
33692
35920
|
// src/output/render.ts
|
|
35921
|
+
var PROBLEM_HINTS = ["hint", "errors", "violations", "title", "type"];
|
|
35922
|
+
function serverProblem(raw) {
|
|
35923
|
+
const value = record(raw);
|
|
35924
|
+
const problem = {};
|
|
35925
|
+
for (const member of ["code", "detail", ...PROBLEM_HINTS, "status"]) {
|
|
35926
|
+
const entry = value[member];
|
|
35927
|
+
if (entry !== undefined && entry !== null)
|
|
35928
|
+
problem[member] = entry;
|
|
35929
|
+
}
|
|
35930
|
+
const adds = PROBLEM_HINTS.some((member) => Array.isArray(problem[member]) ? problem[member].length > 0 : problem[member] !== undefined);
|
|
35931
|
+
return adds ? problem : undefined;
|
|
35932
|
+
}
|
|
35933
|
+
function problemLines(problem) {
|
|
35934
|
+
const lines = [];
|
|
35935
|
+
for (const group of [problem?.errors, problem?.violations]) {
|
|
35936
|
+
for (const item of Array.isArray(group) ? group : []) {
|
|
35937
|
+
const entry = record(item);
|
|
35938
|
+
const where = scalar(entry.pointer ?? entry.field);
|
|
35939
|
+
const detail = scalar(entry.detail ?? entry.message ?? entry.reason);
|
|
35940
|
+
if (where || detail)
|
|
35941
|
+
lines.push(`${where ? `${where}: ` : ""}${detail}`);
|
|
35942
|
+
}
|
|
35943
|
+
}
|
|
35944
|
+
return lines;
|
|
35945
|
+
}
|
|
33693
35946
|
function errorJSON(result, ctx) {
|
|
33694
|
-
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 } : {} } }) + `
|
|
35947
|
+
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 } : {} } }) + `
|
|
33695
35948
|
`;
|
|
33696
35949
|
}
|
|
33697
35950
|
function render(result, ctx) {
|
|
@@ -33847,6 +36100,8 @@ function errorInput(error, ctx) {
|
|
|
33847
36100
|
const raw = record(sdk?.raw), nested = record(raw.error);
|
|
33848
36101
|
const candidate = nested.details ?? raw.details;
|
|
33849
36102
|
const details = candidate !== null && typeof candidate === "object" && !Array.isArray(candidate) ? candidate : undefined;
|
|
36103
|
+
const problem = serverProblem(Object.keys(nested).length ? nested : raw);
|
|
36104
|
+
const serverText = (value) => typeof value === "string" && value.trim() ? value : undefined;
|
|
33850
36105
|
let message = error instanceof Error ? error.message : "Unexpected error";
|
|
33851
36106
|
const prefix = message.match(/^([A-Z][A-Z0-9_]+):\s*/)?.[1];
|
|
33852
36107
|
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");
|
|
@@ -33858,22 +36113,25 @@ function errorInput(error, ctx) {
|
|
|
33858
36113
|
if (stripped)
|
|
33859
36114
|
message = `${humanize(code)}${message ? `: ${message}` : ""}`;
|
|
33860
36115
|
const status = sdk?.status, request_id = sdk?.requestId;
|
|
36116
|
+
message = serverText(problem?.detail) ?? serverText(problem?.title) ?? message;
|
|
33861
36117
|
const authFailure = status === 401 || ["NOT_LOGGED_IN", "UNAUTHENTICATED", "TOKEN_REVOKED", "LOGIN_FAILED"].includes(code);
|
|
33862
36118
|
const source = ctx.credentialSource ?? "login";
|
|
33863
|
-
let
|
|
36119
|
+
let hint2 = genericHint;
|
|
33864
36120
|
if (error instanceof UsageError)
|
|
33865
|
-
|
|
36121
|
+
hint2 = error.hint;
|
|
36122
|
+
else if (serverText(problem?.hint))
|
|
36123
|
+
hint2 = serverText(problem?.hint);
|
|
33866
36124
|
else if (authFailure)
|
|
33867
|
-
|
|
36125
|
+
hint2 = authHint(source);
|
|
33868
36126
|
else if (status === 404)
|
|
33869
|
-
|
|
36127
|
+
hint2 = ctx.listCommand ? `Check the id; list existing ones with \`${ctx.listCommand}\`` : "Check the id.";
|
|
33870
36128
|
else if (status === 403)
|
|
33871
|
-
|
|
36129
|
+
hint2 = "Check that your account or API key has permission to access this resource.";
|
|
33872
36130
|
else if (status === 429)
|
|
33873
|
-
|
|
36131
|
+
hint2 = "Rate limited; retry later.";
|
|
33874
36132
|
else if (status !== undefined && status >= 500)
|
|
33875
|
-
|
|
33876
|
-
return { kind: "error", code, message, hint, ...details !== undefined ? { details } : {}, env: ctx.env, ...authFailure ? { credential_source: source } : {}, ...status !== undefined ? { status } : {}, ...request_id ? { request_id } : {} };
|
|
36133
|
+
hint2 = `Server error; retry later.${request_id ? ` Request id: ${request_id}.` : ""}`;
|
|
36134
|
+
return { kind: "error", code, message, hint: hint2, ...details !== undefined ? { details } : {}, ...problem !== undefined ? { problem } : {}, env: ctx.env, ...authFailure ? { credential_source: source } : {}, ...status !== undefined ? { status } : {}, ...request_id ? { request_id } : {} };
|
|
33877
36135
|
}
|
|
33878
36136
|
|
|
33879
36137
|
// src/output/progress.ts
|
|
@@ -33903,7 +36161,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
|
|
|
33903
36161
|
}
|
|
33904
36162
|
|
|
33905
36163
|
// src/main.ts
|
|
33906
|
-
var version = "0.2.1-dev.
|
|
36164
|
+
var version = "0.2.1-dev.73a8792";
|
|
33907
36165
|
var commands = commandTree(operations);
|
|
33908
36166
|
var manual = [...workflows.map((w) => w.words), [API_WORD]];
|
|
33909
36167
|
function route(argv) {
|
|
@@ -33988,7 +36246,14 @@ var defaults = {
|
|
|
33988
36246
|
var appOptions = {
|
|
33989
36247
|
"app create": [{ name: "dir", type: "string", description: "Directory to create the project in (default: ./<name>)." }, { name: "template", type: "string", description: "Copy a local template directory instead of downloading the standard template." }, { name: "no-install", type: "boolean", description: "Skip installing dependencies." }],
|
|
33990
36248
|
"app deploy": [{ name: "dir", type: "string", description: "Project directory (default: the nearest parent containing praxis.jsonc)." }, { name: "no-build", type: "boolean", description: "Publish the existing dist/ output without building." }],
|
|
33991
|
-
"app rollback": [{ name: "dir", type: "string", description: "Project directory (default: the nearest parent containing praxis.jsonc)." }, { name: "to", type: "string", description: "Version id to deploy (default: the previous version)." }]
|
|
36249
|
+
"app rollback": [{ name: "dir", type: "string", description: "Project directory (default: the nearest parent containing praxis.jsonc)." }, { name: "to", type: "string", description: "Version id to deploy (default: the previous version)." }],
|
|
36250
|
+
"devops test run": [
|
|
36251
|
+
{ name: "project", type: "string", description: "DevOps project id (dvp_…); default: the devops.project field of praxis.jsonc in the current directory." },
|
|
36252
|
+
{ name: "remote", type: "boolean", description: "Run the cases on the Praxis cloud executor. Required; local execution does not exist yet." },
|
|
36253
|
+
{ name: "no-wait", type: "boolean", description: "Return as soon as the run exists instead of waiting for a verdict." },
|
|
36254
|
+
{ name: "repeat", type: "string", description: "How many times each selected case runs (default: 1)." },
|
|
36255
|
+
{ name: "select", type: "string", repeated: true, description: "Narrow the selection; repeatable. tag:<tag> (a bare word reads as a tag), package:<path>, suite:<path> or file:<path>." }
|
|
36256
|
+
]
|
|
33992
36257
|
};
|
|
33993
36258
|
async function main(argv, injected = {}) {
|
|
33994
36259
|
const ports = { ...defaults, ...injected };
|
|
@@ -34121,7 +36386,7 @@ Examples:
|
|
|
34121
36386
|
let owner = client2;
|
|
34122
36387
|
for (const part of op.resource.split("."))
|
|
34123
36388
|
owner = owner[part];
|
|
34124
|
-
|
|
36389
|
+
let result = await owner[op.method](opts);
|
|
34125
36390
|
const name2 = `${op.resource}.${op.method}`;
|
|
34126
36391
|
const list = (items) => {
|
|
34127
36392
|
const view = clientList(items, op, flags.limit, ctx.mode);
|
|
@@ -34135,7 +36400,21 @@ Examples:
|
|
|
34135
36400
|
const cursor = result instanceof Page ? result.next_cursor : record(result).next_cursor ?? record(result).nextToken;
|
|
34136
36401
|
if (typeof cursor === "string" && cursor)
|
|
34137
36402
|
ctx.nextCommand = nextPageCommand(selected.command, parsed, cursor);
|
|
34138
|
-
|
|
36403
|
+
const pageToken = pageTokenField(op), token = pageToken?.sdkName ?? pageToken?.name;
|
|
36404
|
+
const firstPage = flags.all && !(result instanceof Page) && token ? pageOf(result) : undefined;
|
|
36405
|
+
if (flags.all && !(result instanceof Page) && token && !firstPage)
|
|
36406
|
+
throw new UsageError(`--all cannot find the list in ${op.resource}.${op.method}'s response; page with --${token.replace(/_/g, "-")} instead`);
|
|
36407
|
+
if (firstPage) {
|
|
36408
|
+
const items = [...firstPage.items];
|
|
36409
|
+
const seen = new Set;
|
|
36410
|
+
for (let next = firstPage.token;next && !seen.has(next); next = pageOf(result)?.token) {
|
|
36411
|
+
seen.add(next);
|
|
36412
|
+
result = await owner[op.method]({ ...opts, query: { ...opts.query, [token]: next } });
|
|
36413
|
+
items.push(...pageOf(result)?.items ?? []);
|
|
36414
|
+
}
|
|
36415
|
+
ctx.nextCommand = undefined;
|
|
36416
|
+
emit({ kind: "list", ...list(items), ...ctx.mode === "json" ? { raw: { data: items, next_page_token: null } } : {}, nextCursor: null, op: name2 });
|
|
36417
|
+
} else if (result instanceof Page) {
|
|
34139
36418
|
if (flags.all) {
|
|
34140
36419
|
const items = [];
|
|
34141
36420
|
for await (const item of result)
|
|
@@ -34209,6 +36488,26 @@ Examples:
|
|
|
34209
36488
|
await appRollback({ dir, to: parsed.flags.to?.[0] }, client2, appPorts);
|
|
34210
36489
|
break;
|
|
34211
36490
|
}
|
|
36491
|
+
case "devops test run": {
|
|
36492
|
+
return await devopsTestRun({
|
|
36493
|
+
project: parsed.flags.project?.[0],
|
|
36494
|
+
remote: Boolean(parsed.flags.remote),
|
|
36495
|
+
wait: !parsed.flags["no-wait"],
|
|
36496
|
+
repeat: parsed.flags.repeat?.[0],
|
|
36497
|
+
select: parsed.flags.select
|
|
36498
|
+
}, async () => await auth.client(org), config.env, {
|
|
36499
|
+
git: (args, cwd) => ports.spawnCapture("git", args, { cwd }),
|
|
36500
|
+
readFile: ports.readFile,
|
|
36501
|
+
wait: ports.wait,
|
|
36502
|
+
mode: ctx.mode,
|
|
36503
|
+
emit,
|
|
36504
|
+
human: (text) => {
|
|
36505
|
+
if (ctx.mode === "human")
|
|
36506
|
+
emit({ kind: "message", channel: "stdout", text });
|
|
36507
|
+
},
|
|
36508
|
+
cwd: ports.cwd
|
|
36509
|
+
});
|
|
36510
|
+
}
|
|
34212
36511
|
case "api": {
|
|
34213
36512
|
const method = parsed.positional[0];
|
|
34214
36513
|
if (!HTTP_METHOD.test(method))
|
|
@@ -34231,7 +36530,7 @@ Examples:
|
|
|
34231
36530
|
}
|
|
34232
36531
|
}
|
|
34233
36532
|
if (true)
|
|
34234
|
-
process.
|
|
36533
|
+
process.exitCode = await main(process.argv.slice(2));
|
|
34235
36534
|
export {
|
|
34236
36535
|
main
|
|
34237
36536
|
};
|