@deepraxis/sdk 0.1.0-dev.a5cf3ce → 0.1.0-dev.b7ae389
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/METHODS.md +152 -1
- package/dist/core/client.d.ts +5 -1
- package/dist/core/client.js +3 -0
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +343 -19
- package/dist/generated/sdk.gen.js +1053 -18
- package/dist/generated/types.gen.d.ts +26651 -21213
- package/dist/helpers/file-upload.d.ts +24 -0
- package/dist/helpers/file-upload.js +113 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +1 -0
- package/dist/operations.generated.d.ts +1541 -28
- package/dist/operations.generated.js +1957 -61
- package/dist/resources.generated.d.ts +651 -0
- package/dist/resources.generated.js +97 -0
- package/package.json +1 -1
|
@@ -128,6 +128,13 @@ export const operations = [
|
|
|
128
128
|
"required": false,
|
|
129
129
|
"description": "Tool configurations available to the agent. Maximum of 128 tools\nacross all toolsets allowed."
|
|
130
130
|
},
|
|
131
|
+
{
|
|
132
|
+
"name": "bindings",
|
|
133
|
+
"type": "array",
|
|
134
|
+
"itemType": "object",
|
|
135
|
+
"required": false,
|
|
136
|
+
"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; 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_..., 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 browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. A resource that is not bound returns 404, a service that is not opened returns 403, and writes to read_only resources are refused. 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."
|
|
137
|
+
},
|
|
131
138
|
{
|
|
132
139
|
"name": "kind",
|
|
133
140
|
"type": "string",
|
|
@@ -176,6 +183,18 @@ export const operations = [
|
|
|
176
183
|
"required": false,
|
|
177
184
|
"description": "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable."
|
|
178
185
|
},
|
|
186
|
+
{
|
|
187
|
+
"name": "avatar",
|
|
188
|
+
"type": "string",
|
|
189
|
+
"required": false,
|
|
190
|
+
"description": "Avatar image of the agent: an absolute https URL of at most 2048 characters, without credentials; any other value returns 400 avatar must be an https URL. It is the default picture in agent lists, the agent detail, the chat header and embedded chat when the embed appearance sets none. Saved with the agent version like other configuration, so apply=false keeps the previous avatar in effect until that version is applied. Omit on create for no avatar; on update, omit to keep it and send null to clear it. Both personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
191
|
+
},
|
|
192
|
+
{
|
|
193
|
+
"name": "environment_id",
|
|
194
|
+
"type": "string",
|
|
195
|
+
"required": false,
|
|
196
|
+
"description": "Default environment of a service agent: the environment_id a new session gets when it names none. Use light, node22 or the env_ id of an active environment of your organization; any other value returns 400 environment_id <id> was not found. null means no environment, so sessions are plain conversation without codemode or bash. Saved with the agent version like other configuration, so apply=false keeps the previous environment in effect for new sessions until that version is applied; a session that sets environment_id itself, null included, overrides it. Omit on create for light; on update, omit to keep it. Versions saved before this field existed read as light. Personal agents use a Computer: a non-null value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
197
|
+
},
|
|
179
198
|
{
|
|
180
199
|
"name": "preset",
|
|
181
200
|
"type": "string",
|
|
@@ -218,7 +237,7 @@ export const operations = [
|
|
|
218
237
|
"resource": "agent.agents",
|
|
219
238
|
"method": "update",
|
|
220
239
|
"summary": "Update agent",
|
|
221
|
-
"description": "Update an agent. Send the current version in the body for optimistic concurrency: a stale version returns 409, and an update that changes nothing keeps the version number. Any real change saves a new version
|
|
240
|
+
"description": "Update an agent. Send the current version in the body for optimistic concurrency: a stale version returns 409, and an update that changes nothing keeps the version number. Any real change saves a new version. apply defaults to true and moves active_version to the new version, or to the latest when configuration is unchanged; apply false saves without applying. version_note optionally records up to 280 characters on a newly created version. Existing sessions and tokens keep their version. Omitted fields keep their value. multiagent takes null or a coordinator roster; subagent_model keeps its value when omitted and is cleared by null. Archived agents cannot be updated. Unlike Anthropic Managed Agents, nonempty skills attachments return 400; use the native skill tool for available runtime skills.",
|
|
222
241
|
"http": "POST",
|
|
223
242
|
"path": "/agent/v1/agents/{agent_id}",
|
|
224
243
|
"streaming": "no",
|
|
@@ -296,6 +315,25 @@ export const operations = [
|
|
|
296
315
|
"required": false,
|
|
297
316
|
"description": "The agent's current version, used to prevent concurrent overwrites.\nObtain this value from a create or retrieve response. Must be at least 1 if\nspecified. When supplied, the request fails if it does not match the server's\ncurrent version; omit to apply the update unconditionally."
|
|
298
317
|
},
|
|
318
|
+
{
|
|
319
|
+
"name": "apply",
|
|
320
|
+
"type": "boolean",
|
|
321
|
+
"required": false,
|
|
322
|
+
"description": "Defaults to true: apply the newly saved version, or the latest version when configuration is unchanged. Set false to save without changing active_version. Unlike Managed Agents, saving and applying can be separate."
|
|
323
|
+
},
|
|
324
|
+
{
|
|
325
|
+
"name": "version_note",
|
|
326
|
+
"type": "string",
|
|
327
|
+
"required": false,
|
|
328
|
+
"description": "Optional change explanation stored as note on the new immutable version, up to 280 characters. Omission stores null. A note alone does not create a version or rewrite an existing note."
|
|
329
|
+
},
|
|
330
|
+
{
|
|
331
|
+
"name": "bindings",
|
|
332
|
+
"type": "array",
|
|
333
|
+
"itemType": "object",
|
|
334
|
+
"required": false,
|
|
335
|
+
"description": "Replace the whole bindings list; omission preserves it, and null or [] clears it. Additions apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Only service agents accept a nonempty list."
|
|
336
|
+
},
|
|
299
337
|
{
|
|
300
338
|
"name": "kind",
|
|
301
339
|
"type": "string",
|
|
@@ -344,6 +382,18 @@ export const operations = [
|
|
|
344
382
|
"required": false,
|
|
345
383
|
"description": "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable."
|
|
346
384
|
},
|
|
385
|
+
{
|
|
386
|
+
"name": "avatar",
|
|
387
|
+
"type": "string",
|
|
388
|
+
"required": false,
|
|
389
|
+
"description": "Avatar image of the agent: an absolute https URL of at most 2048 characters, without credentials; any other value returns 400 avatar must be an https URL. It is the default picture in agent lists, the agent detail, the chat header and embedded chat when the embed appearance sets none. Saved with the agent version like other configuration, so apply=false keeps the previous avatar in effect until that version is applied. Omit on create for no avatar; on update, omit to keep it and send null to clear it. Both personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
390
|
+
},
|
|
391
|
+
{
|
|
392
|
+
"name": "environment_id",
|
|
393
|
+
"type": "string",
|
|
394
|
+
"required": false,
|
|
395
|
+
"description": "Default environment of a service agent: the environment_id a new session gets when it names none. Use light, node22 or the env_ id of an active environment of your organization; any other value returns 400 environment_id <id> was not found. null means no environment, so sessions are plain conversation without codemode or bash. Saved with the agent version like other configuration, so apply=false keeps the previous environment in effect for new sessions until that version is applied; a session that sets environment_id itself, null included, overrides it. Omit on create for light; on update, omit to keep it. Versions saved before this field existed read as light. Personal agents use a Computer: a non-null value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
396
|
+
},
|
|
347
397
|
{
|
|
348
398
|
"name": "preset",
|
|
349
399
|
"type": "string",
|
|
@@ -591,6 +641,27 @@ export const operations = [
|
|
|
591
641
|
}
|
|
592
642
|
]
|
|
593
643
|
},
|
|
644
|
+
{
|
|
645
|
+
"resource": "agent.agents.versions",
|
|
646
|
+
"method": "apply",
|
|
647
|
+
"summary": "Apply Agent Version",
|
|
648
|
+
"description": "Apply a version from agents.versions.list by its version number. This idempotent operation changes active_version without creating a version; existing sessions and tokens keep their version. The response is the latest saved agent with its current active_version. Missing versions return 404 Agent version not found; archived agents return 409 Agent is archived. For example, POST /agent/v1/agents/{agent_id}/versions/2/apply with no body.",
|
|
649
|
+
"http": "POST",
|
|
650
|
+
"path": "/agent/v1/agents/{agent_id}/versions/{version}/apply",
|
|
651
|
+
"streaming": "no",
|
|
652
|
+
"pagination": false,
|
|
653
|
+
"pathParams": [
|
|
654
|
+
{
|
|
655
|
+
"name": "agent_id",
|
|
656
|
+
"sdkName": "agent_id"
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
"name": "version",
|
|
660
|
+
"sdkName": "version"
|
|
661
|
+
}
|
|
662
|
+
],
|
|
663
|
+
"query": []
|
|
664
|
+
},
|
|
594
665
|
{
|
|
595
666
|
"resource": "agent.computers",
|
|
596
667
|
"method": "list",
|
|
@@ -756,7 +827,7 @@ export const operations = [
|
|
|
756
827
|
"resource": "agent.computers",
|
|
757
828
|
"method": "connect",
|
|
758
829
|
"summary": "Connect computer",
|
|
759
|
-
"description": "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.\n\nConnect to a computer with a caller-held lease. Omit the body or send {} to request light: the lightweight shell, or the heavy instance while it is running. Send {\"need\":\"heavy\"} to request full Linux for interactive programs; files are synchronized before the heavy connection is returned with tier heavy.
|
|
830
|
+
"description": "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.\n\nConnect to a computer with a caller-held lease. Omit the body or send {} to request light: the lightweight shell, or the heavy instance while it is running. Send {\"need\":\"heavy\"} to request full Linux for interactive programs; files are synchronized before the heavy connection is returned with tier heavy. Renew the lease while using the connection and release it with DELETE when finished.",
|
|
760
831
|
"http": "POST",
|
|
761
832
|
"path": "/agent/v1/computers/{computer_id}/connect",
|
|
762
833
|
"streaming": "no",
|
|
@@ -1793,7 +1864,7 @@ export const operations = [
|
|
|
1793
1864
|
"resource": "agent.sessions",
|
|
1794
1865
|
"method": "create",
|
|
1795
1866
|
"summary": "Create session",
|
|
1796
|
-
"description": "Create a session: one conversation with an agent
|
|
1867
|
+
"description": "Create a session: one conversation with an agent. Pass agent as an agent id (active_version) or {id, version, type:\"agent\"}. Unlike Anthropic Managed Agents, omit environment_id to get a light machine, unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, omission returns environment_id=light; explicit null allocates no machine, so codemode, bash and other machine tools are unavailable. Optional model must be one of the agent's allowed models; optional thinking is {effort: low|medium|high|xhigh|max|none} or null, where null inherits the agent default and then the model default (none requires the model to allow disabling thinking). Selections are saved before initial_events run; invalid ones return 400 invalid_request_error. Inline agent overrides are not supported. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. Omitted budget defaults to USD 20; null removes the limit, and a limit object uses a positive integer string of USD cents. Up to 500 file resources can be attached. Use initial_events to send a first user.message in this request, or send messages afterwards with sessions.events.send. The returned status can still be idle before initial events run; read agent.message and the subsequent session.status_idle event to confirm completion.",
|
|
1797
1868
|
"http": "POST",
|
|
1798
1869
|
"path": "/agent/v1/sessions",
|
|
1799
1870
|
"streaming": "no",
|
|
@@ -1813,7 +1884,7 @@ export const operations = [
|
|
|
1813
1884
|
"name": "environment_id",
|
|
1814
1885
|
"type": "string",
|
|
1815
1886
|
"required": false,
|
|
1816
|
-
"description": "
|
|
1887
|
+
"description": "Execution environment id from agent.environments.list or agent.environments.create. For a service agent, omission selects the built-in light environment and returns session.environment_id=light; explicit null allocates no machine and makes machine tools, including codemode and bash, unavailable. Personal agents use their selected Computer."
|
|
1817
1888
|
},
|
|
1818
1889
|
{
|
|
1819
1890
|
"name": "budget",
|
|
@@ -2679,6 +2750,225 @@ export const operations = [
|
|
|
2679
2750
|
}
|
|
2680
2751
|
]
|
|
2681
2752
|
},
|
|
2753
|
+
{
|
|
2754
|
+
"resource": "agent.skills",
|
|
2755
|
+
"method": "list",
|
|
2756
|
+
"summary": "List skills",
|
|
2757
|
+
"description": "List the skills uploaded to your organization, newest first, in pages of at most 100 (default 20). Use it to find a skill id before reading, versioning or deleting it. Only source=custom has content; source=anthropic returns an empty list. Pass next_page from the response as page to read the next page; a null next_page means the end.",
|
|
2758
|
+
"http": "GET",
|
|
2759
|
+
"path": "/agent/v1/skills",
|
|
2760
|
+
"streaming": "no",
|
|
2761
|
+
"pagination": false,
|
|
2762
|
+
"pathParams": [],
|
|
2763
|
+
"query": [
|
|
2764
|
+
{
|
|
2765
|
+
"name": "source",
|
|
2766
|
+
"type": "string",
|
|
2767
|
+
"required": false,
|
|
2768
|
+
"description": "Filter skills by source.\n\nIf provided, only skills from the specified source will be returned:\n\n- `\"custom\"`: only return user-created skills\n- `\"anthropic\"`: only return Anthropic-created skills"
|
|
2769
|
+
},
|
|
2770
|
+
{
|
|
2771
|
+
"name": "limit",
|
|
2772
|
+
"type": "number",
|
|
2773
|
+
"required": false,
|
|
2774
|
+
"description": "Number of items per page."
|
|
2775
|
+
},
|
|
2776
|
+
{
|
|
2777
|
+
"name": "page",
|
|
2778
|
+
"type": "string",
|
|
2779
|
+
"required": false,
|
|
2780
|
+
"description": "Opaque pagination cursor: pass the next_page value of the previous response unchanged. Omit it for the first page. A cursor from a different query or a malformed one returns 400."
|
|
2781
|
+
}
|
|
2782
|
+
]
|
|
2783
|
+
},
|
|
2784
|
+
{
|
|
2785
|
+
"resource": "agent.skills",
|
|
2786
|
+
"method": "create",
|
|
2787
|
+
"summary": "Create skill",
|
|
2788
|
+
"description": "Upload a skill: a directory that contains SKILL.md, which the agent reads when it needs the skill. Send multipart/form-data with one files part per file, each file name being its path under one top-level directory (pdf/SKILL.md, pdf/scripts/run.py), and an optional display_name. SKILL.md frontmatter needs a description; name defaults to the directory name. Limits: 8 MB in total, at most 200 files, no .. segments, absolute paths or empty names; a violation returns 400 naming the path or field. The upload creates the skill and its first version, and versions are immutable. Attach the skill to an agent with `skills` on the agent.",
|
|
2789
|
+
"http": "POST",
|
|
2790
|
+
"path": "/agent/v1/skills",
|
|
2791
|
+
"streaming": "no",
|
|
2792
|
+
"pagination": false,
|
|
2793
|
+
"multipart": true,
|
|
2794
|
+
"pathParams": [],
|
|
2795
|
+
"query": [],
|
|
2796
|
+
"body": {
|
|
2797
|
+
"required": true,
|
|
2798
|
+
"fields": [
|
|
2799
|
+
{
|
|
2800
|
+
"name": "files",
|
|
2801
|
+
"type": "array",
|
|
2802
|
+
"itemType": "string",
|
|
2803
|
+
"required": true,
|
|
2804
|
+
"description": "Files to upload for the skill.\n\nAll files must be in the same top-level directory and must include a SKILL.md\nfile at the root of that directory."
|
|
2805
|
+
},
|
|
2806
|
+
{
|
|
2807
|
+
"name": "display_name",
|
|
2808
|
+
"type": "string",
|
|
2809
|
+
"required": false,
|
|
2810
|
+
"description": "Human-readable, single-line label for the Skill. Maximum 255\ncharacters. Always set: derived from the SKILL.md frontmatter `name` when\nomitted at creation. Not unique."
|
|
2811
|
+
}
|
|
2812
|
+
]
|
|
2813
|
+
}
|
|
2814
|
+
},
|
|
2815
|
+
{
|
|
2816
|
+
"resource": "agent.skills",
|
|
2817
|
+
"method": "delete",
|
|
2818
|
+
"summary": "Delete skill",
|
|
2819
|
+
"description": "Delete a skill that has no live versions. A skill that still has versions returns 409 Delete all versions first; remove each with skills.versions.delete, then call this. Returns {id, type: skill_deleted}. skill_id comes from skills.create or skills.list.",
|
|
2820
|
+
"http": "DELETE",
|
|
2821
|
+
"path": "/agent/v1/skills/{skill_id}",
|
|
2822
|
+
"streaming": "no",
|
|
2823
|
+
"pagination": false,
|
|
2824
|
+
"pathParams": [
|
|
2825
|
+
{
|
|
2826
|
+
"name": "skill_id",
|
|
2827
|
+
"sdkName": "skill_id"
|
|
2828
|
+
}
|
|
2829
|
+
],
|
|
2830
|
+
"query": []
|
|
2831
|
+
},
|
|
2832
|
+
{
|
|
2833
|
+
"resource": "agent.skills",
|
|
2834
|
+
"method": "retrieve",
|
|
2835
|
+
"summary": "Get skill",
|
|
2836
|
+
"description": "Read one skill by id: its display_name, source and latest_version_id. skill_id comes from skills.create or skills.list. A skill of another organization, or a deleted one, returns 404 Skill not found.",
|
|
2837
|
+
"http": "GET",
|
|
2838
|
+
"path": "/agent/v1/skills/{skill_id}",
|
|
2839
|
+
"streaming": "no",
|
|
2840
|
+
"pagination": false,
|
|
2841
|
+
"pathParams": [
|
|
2842
|
+
{
|
|
2843
|
+
"name": "skill_id",
|
|
2844
|
+
"sdkName": "skill_id"
|
|
2845
|
+
}
|
|
2846
|
+
],
|
|
2847
|
+
"query": []
|
|
2848
|
+
},
|
|
2849
|
+
{
|
|
2850
|
+
"resource": "agent.skills.versions",
|
|
2851
|
+
"method": "list",
|
|
2852
|
+
"summary": "List skill versions",
|
|
2853
|
+
"description": "List the live versions of one skill, newest first, in pages of at most 100 (default 20). Each item carries the name and description read from the SKILL.md of that version. Pass next_page from the response as page to read the next page; a null next_page means the end.",
|
|
2854
|
+
"http": "GET",
|
|
2855
|
+
"path": "/agent/v1/skills/{skill_id}/versions",
|
|
2856
|
+
"streaming": "no",
|
|
2857
|
+
"pagination": false,
|
|
2858
|
+
"pathParams": [
|
|
2859
|
+
{
|
|
2860
|
+
"name": "skill_id",
|
|
2861
|
+
"sdkName": "skill_id"
|
|
2862
|
+
}
|
|
2863
|
+
],
|
|
2864
|
+
"query": [
|
|
2865
|
+
{
|
|
2866
|
+
"name": "limit",
|
|
2867
|
+
"type": "number",
|
|
2868
|
+
"required": false,
|
|
2869
|
+
"description": "Number of items per page."
|
|
2870
|
+
},
|
|
2871
|
+
{
|
|
2872
|
+
"name": "page",
|
|
2873
|
+
"type": "string",
|
|
2874
|
+
"required": false,
|
|
2875
|
+
"description": "Opaque pagination cursor: pass the next_page value of the previous response unchanged. Omit it for the first page. A cursor from a different query or a malformed one returns 400."
|
|
2876
|
+
}
|
|
2877
|
+
]
|
|
2878
|
+
},
|
|
2879
|
+
{
|
|
2880
|
+
"resource": "agent.skills.versions",
|
|
2881
|
+
"method": "create",
|
|
2882
|
+
"summary": "Create skill version",
|
|
2883
|
+
"description": "Upload a new version of a skill with the same multipart/form-data shape and limits as skills.create (8 MB, 200 files, one top-level directory containing SKILL.md). The SKILL.md name must equal the name of the skill; a different name returns 400. The new version becomes latest_version_id of the skill, and earlier versions stay unchanged because versions are immutable. Attach it to an agent with `skills` on the agent.",
|
|
2884
|
+
"http": "POST",
|
|
2885
|
+
"path": "/agent/v1/skills/{skill_id}/versions",
|
|
2886
|
+
"streaming": "no",
|
|
2887
|
+
"pagination": false,
|
|
2888
|
+
"multipart": true,
|
|
2889
|
+
"pathParams": [
|
|
2890
|
+
{
|
|
2891
|
+
"name": "skill_id",
|
|
2892
|
+
"sdkName": "skill_id"
|
|
2893
|
+
}
|
|
2894
|
+
],
|
|
2895
|
+
"query": [],
|
|
2896
|
+
"body": {
|
|
2897
|
+
"required": true,
|
|
2898
|
+
"fields": [
|
|
2899
|
+
{
|
|
2900
|
+
"name": "files",
|
|
2901
|
+
"type": "array",
|
|
2902
|
+
"itemType": "string",
|
|
2903
|
+
"required": true,
|
|
2904
|
+
"description": "Files to upload for the skill.\n\nAll files must be in the same top-level directory and must include a SKILL.md\nfile at the root of that directory."
|
|
2905
|
+
}
|
|
2906
|
+
]
|
|
2907
|
+
}
|
|
2908
|
+
},
|
|
2909
|
+
{
|
|
2910
|
+
"resource": "agent.skills.versions",
|
|
2911
|
+
"method": "delete",
|
|
2912
|
+
"summary": "Delete skill version",
|
|
2913
|
+
"description": "Soft-delete one version of a skill so it can no longer be read or downloaded; latest_version_id of the skill falls back to the newest remaining version. Returns {id, type: skill_version_deleted}. A skill can be deleted only after all of its versions are deleted.",
|
|
2914
|
+
"http": "DELETE",
|
|
2915
|
+
"path": "/agent/v1/skills/{skill_id}/versions/{version}",
|
|
2916
|
+
"streaming": "no",
|
|
2917
|
+
"pagination": false,
|
|
2918
|
+
"pathParams": [
|
|
2919
|
+
{
|
|
2920
|
+
"name": "skill_id",
|
|
2921
|
+
"sdkName": "skill_id"
|
|
2922
|
+
},
|
|
2923
|
+
{
|
|
2924
|
+
"name": "version",
|
|
2925
|
+
"sdkName": "version"
|
|
2926
|
+
}
|
|
2927
|
+
],
|
|
2928
|
+
"query": []
|
|
2929
|
+
},
|
|
2930
|
+
{
|
|
2931
|
+
"resource": "agent.skills.versions",
|
|
2932
|
+
"method": "retrieve",
|
|
2933
|
+
"summary": "Get skill version",
|
|
2934
|
+
"description": "Read one version of a skill: its name, description and created_at as read from SKILL.md. version is the id returned by skills.versions.create or skills.versions.list. A deleted or unknown version returns 404 Skill version not found.",
|
|
2935
|
+
"http": "GET",
|
|
2936
|
+
"path": "/agent/v1/skills/{skill_id}/versions/{version}",
|
|
2937
|
+
"streaming": "no",
|
|
2938
|
+
"pagination": false,
|
|
2939
|
+
"pathParams": [
|
|
2940
|
+
{
|
|
2941
|
+
"name": "skill_id",
|
|
2942
|
+
"sdkName": "skill_id"
|
|
2943
|
+
},
|
|
2944
|
+
{
|
|
2945
|
+
"name": "version",
|
|
2946
|
+
"sdkName": "version"
|
|
2947
|
+
}
|
|
2948
|
+
],
|
|
2949
|
+
"query": []
|
|
2950
|
+
},
|
|
2951
|
+
{
|
|
2952
|
+
"resource": "agent.skills.versions",
|
|
2953
|
+
"method": "retrieveContent",
|
|
2954
|
+
"summary": "Download skill version",
|
|
2955
|
+
"description": "Download the content of one version as a zip archive (application/zip): the uploaded directory with its top-level folder and every file. version is the id returned by skills.versions.create or skills.versions.list; a deleted version returns 404.",
|
|
2956
|
+
"http": "GET",
|
|
2957
|
+
"path": "/agent/v1/skills/{skill_id}/versions/{version}/content",
|
|
2958
|
+
"streaming": "no",
|
|
2959
|
+
"pagination": false,
|
|
2960
|
+
"pathParams": [
|
|
2961
|
+
{
|
|
2962
|
+
"name": "skill_id",
|
|
2963
|
+
"sdkName": "skill_id"
|
|
2964
|
+
},
|
|
2965
|
+
{
|
|
2966
|
+
"name": "version",
|
|
2967
|
+
"sdkName": "version"
|
|
2968
|
+
}
|
|
2969
|
+
],
|
|
2970
|
+
"query": []
|
|
2971
|
+
},
|
|
2682
2972
|
{
|
|
2683
2973
|
"resource": "agent.toolsets",
|
|
2684
2974
|
"method": "list",
|
|
@@ -3521,13 +3811,13 @@ export const operations = [
|
|
|
3521
3811
|
"name": "namespace",
|
|
3522
3812
|
"type": "string",
|
|
3523
3813
|
"required": true,
|
|
3524
|
-
"description": "Choose a namespace without prior registration; praxis is
|
|
3814
|
+
"description": "Choose a namespace without prior registration; praxis is reserved for built-in Actions. Folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
3525
3815
|
},
|
|
3526
3816
|
{
|
|
3527
3817
|
"name": "name",
|
|
3528
3818
|
"type": "string",
|
|
3529
3819
|
"required": true,
|
|
3530
|
-
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
3820
|
+
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
3531
3821
|
},
|
|
3532
3822
|
{
|
|
3533
3823
|
"name": "description",
|
|
@@ -3590,8 +3880,8 @@ export const operations = [
|
|
|
3590
3880
|
{
|
|
3591
3881
|
"resource": "automation.actions",
|
|
3592
3882
|
"method": "retrieve",
|
|
3593
|
-
"summary": "Get an
|
|
3594
|
-
"description": "Read the
|
|
3883
|
+
"summary": "Get an Action with its current input and output JSON Schemas",
|
|
3884
|
+
"description": "Read the Action and its full current implementation, with input and output JSON Schemas at current_revision.input_schema and current_revision.output_schema. To read a built-in Action, use ns=praxis and name=<bare name>, for example name=ocr; invoke it in a script with call(\"ocr\", input). The response ETag is the current revision ID for conditional updates.",
|
|
3595
3885
|
"http": "GET",
|
|
3596
3886
|
"path": "/automation/v1/actions/{ns}/{name}",
|
|
3597
3887
|
"streaming": "no",
|
|
@@ -4165,8 +4455,8 @@ export const operations = [
|
|
|
4165
4455
|
{
|
|
4166
4456
|
"resource": "automation.runs",
|
|
4167
4457
|
"method": "create",
|
|
4168
|
-
"summary": "
|
|
4169
|
-
"description": "Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. Idempotency-Key is scoped to tenant, method and path for 24 hours, excluding wait from the fingerprint; replay returns the current run with Idempotent-Replayed: true, changed contents return 422 and an in-flight request returns 409. New non-deterministic run IDs contain 78 characters
|
|
4458
|
+
"summary": "Run a published target or execute draft source",
|
|
4459
|
+
"description": "Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. Minimal script: `export default async ({ file_id }: { file_id: string }) => { const result = await call(\"ocr\", { document: { type: \"file\", file_id } }); return result; }`; send it as source with language=\"ts\", input={\"file_id\":\"<uploaded file ID>\"} and wait=0, using a PDF or image already uploaded to your account. To call a platform API directly in the same script, use the praxis SDK object, for example `praxis.model.ocr.create({ body: { model: \"glm-ocr\", document: { type: \"file\", file_id } } })`; Action IDs are strings passed to call(), not SDK methods such as praxis.ocr(...). praxis, call, invoke, console and codemode are module-scope bindings, not on globalThis, and need no import; invoke(\"namespace/name\", input) starts a child run. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. For long-running, background or batch work, use wait: 0 and poll the run, or split work into child runs or a workflow; wait only controls the response wait and does not extend execution limits. Actions time out after 30 s (run-sandbox after 10 min); scripts have a 5 min wall-clock limit and a 30 s CPU limit; workflows default to 24 h and allow up to 7 days. Each run can start at most 100 child runs, with at most 20 active at once; nesting depth is limited to 10. Idempotency-Key is scoped to tenant, method and path for 24 hours, excluding wait from the fingerprint; replay returns the current run with Idempotent-Replayed: true, changed contents return 422 and an in-flight request returns 409. New non-deterministic run IDs contain 78 characters, compared with 46 for legacy random IDs; treat IDs as opaque strings. Historical and deterministic IDs remain valid; same-millisecond order is not guaranteed.",
|
|
4170
4460
|
"http": "POST",
|
|
4171
4461
|
"path": "/automation/v1/runs",
|
|
4172
4462
|
"streaming": "no",
|
|
@@ -4644,7 +4934,7 @@ export const operations = [
|
|
|
4644
4934
|
"resource": "automation.scripts",
|
|
4645
4935
|
"method": "create",
|
|
4646
4936
|
"summary": "Create a script",
|
|
4647
|
-
"description": "Save a TypeScript script as an editable draft for later reuse; this does not publish or start a run. Choose your own namespace without registering it first; praxis is
|
|
4937
|
+
"description": "Save a TypeScript script as an editable draft for later reuse; this does not publish or start a run. Choose your own namespace without registering it first; praxis is reserved for built-in Actions. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. The draft is a source string with a default-exported function, for example `export default async (input: {name: string}) => ({greeting: \"Hello, \" + input.name});`. Scripts provide praxis, call, invoke, console and codemode as module-scope bindings, not on globalThis, with no import needed: praxis.<domain>.<resource>.<method>(...) calls a platform API, call(\"ocr\", input) calls a built-in Action, and invoke(\"namespace/name\", input) starts a child run. Action IDs are strings (bare names for built-ins, namespace/name for your own Actions); praxis.ocr(...) does not exist. To test it, pass that source and language=ts to praxis.automation.runs.create without publishing. To publish later, use the returned draft.revision as expected_draft_revision.",
|
|
4648
4938
|
"http": "POST",
|
|
4649
4939
|
"path": "/automation/v1/scripts",
|
|
4650
4940
|
"streaming": "no",
|
|
@@ -4658,13 +4948,13 @@ export const operations = [
|
|
|
4658
4948
|
"name": "namespace",
|
|
4659
4949
|
"type": "string",
|
|
4660
4950
|
"required": true,
|
|
4661
|
-
"description": "Choose a namespace without prior registration; praxis is
|
|
4951
|
+
"description": "Choose a namespace without prior registration; praxis is reserved for built-in Actions. Folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
4662
4952
|
},
|
|
4663
4953
|
{
|
|
4664
4954
|
"name": "name",
|
|
4665
4955
|
"type": "string",
|
|
4666
4956
|
"required": true,
|
|
4667
|
-
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
4957
|
+
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
4668
4958
|
},
|
|
4669
4959
|
{
|
|
4670
4960
|
"name": "description",
|
|
@@ -4712,7 +5002,7 @@ export const operations = [
|
|
|
4712
5002
|
"resource": "automation.scripts",
|
|
4713
5003
|
"method": "update",
|
|
4714
5004
|
"summary": "Update a script draft",
|
|
4715
|
-
"description": "Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision.",
|
|
5005
|
+
"description": "Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision. Scripts provide praxis, call, invoke, console and codemode as module-scope bindings, not on globalThis, with no import needed: praxis.<domain>.<resource>.<method>(...) calls a platform API, call(\"ocr\", input) calls a built-in Action, and invoke(\"namespace/name\", input) starts a child run. Action IDs are strings (bare names for built-ins, namespace/name for your own Actions); praxis.ocr(...) does not exist.",
|
|
4716
5006
|
"http": "PATCH",
|
|
4717
5007
|
"path": "/automation/v1/scripts/{ns}/{name}",
|
|
4718
5008
|
"streaming": "no",
|
|
@@ -5666,7 +5956,7 @@ export const operations = [
|
|
|
5666
5956
|
"resource": "automation.workflows",
|
|
5667
5957
|
"method": "create",
|
|
5668
5958
|
"summary": "Create a workflow",
|
|
5669
|
-
"description": "Save a YAML workflow as an editable draft without publishing or starting a run. Choose your own namespace without registering it first; praxis is
|
|
5959
|
+
"description": "Save a YAML workflow as an editable draft without publishing or starting a run. Choose your own namespace without registering it first; praxis is reserved for built-in Actions. To test the draft, send its source and language=yaml to praxis.automation.runs.create. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. run.workflow accepts ns/name@range or {namespace, name, version, input}; run.script uses the same reference shape as a platform extension. Object namespace, name and version are required; version accepts an exact version, dist-tag or range, locked at publication. Object input defaults to {} and supports expressions; string references retain task-level with. run.await defaults to true and returns the child output. With false, the child uses detach and the task immediately returns {run_id}; parent cancellation does not cascade. Inline script.code returns DEFINITION_INVALID with a detail asking you to save a script and reference it first. raise.error retains its type URI, status, title and detail in the run error.",
|
|
5670
5960
|
"http": "POST",
|
|
5671
5961
|
"path": "/automation/v1/workflows",
|
|
5672
5962
|
"streaming": "no",
|
|
@@ -5680,13 +5970,13 @@ export const operations = [
|
|
|
5680
5970
|
"name": "namespace",
|
|
5681
5971
|
"type": "string",
|
|
5682
5972
|
"required": true,
|
|
5683
|
-
"description": "Choose a namespace without prior registration; praxis is
|
|
5973
|
+
"description": "Choose a namespace without prior registration; praxis is reserved for built-in Actions. Folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
5684
5974
|
},
|
|
5685
5975
|
{
|
|
5686
5976
|
"name": "name",
|
|
5687
5977
|
"type": "string",
|
|
5688
5978
|
"required": true,
|
|
5689
|
-
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
5979
|
+
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
5690
5980
|
},
|
|
5691
5981
|
{
|
|
5692
5982
|
"name": "description",
|
|
@@ -7587,7 +7877,7 @@ export const operations = [
|
|
|
7587
7877
|
"resource": "file.files",
|
|
7588
7878
|
"method": "create",
|
|
7589
7879
|
"summary": "Upload file",
|
|
7590
|
-
"description": "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most
|
|
7880
|
+
"description": "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–2592000), or praxis[expires_in_seconds] (3600–7776000), never both. Without expiry, the file persists until deleted.",
|
|
7591
7881
|
"http": "POST",
|
|
7592
7882
|
"path": "/file/v1/files",
|
|
7593
7883
|
"streaming": "no",
|
|
@@ -7602,7 +7892,7 @@ export const operations = [
|
|
|
7602
7892
|
"name": "file",
|
|
7603
7893
|
"type": "string",
|
|
7604
7894
|
"required": true,
|
|
7605
|
-
"description": "File bytes in one multipart file part, not a filename or file ID. The file must be nonempty and at most
|
|
7895
|
+
"description": "File bytes in one multipart file part, not a filename or file ID. The file must be nonempty and at most 100000000 bytes; its content determines the MIME type."
|
|
7606
7896
|
},
|
|
7607
7897
|
{
|
|
7608
7898
|
"name": "purpose",
|
|
@@ -7651,7 +7941,7 @@ export const operations = [
|
|
|
7651
7941
|
"resource": "file.files",
|
|
7652
7942
|
"method": "retrieve",
|
|
7653
7943
|
"summary": "Retrieve file",
|
|
7654
|
-
"description": "Retrieve metadata for a live file owned by your tenant. Use its
|
|
7944
|
+
"description": "Retrieve metadata for a live file owned by your tenant. Use its file- ID from upload or list. Missing, deleted, expired and other-tenant files return 404; use the content endpoint to download the bytes.",
|
|
7655
7945
|
"http": "GET",
|
|
7656
7946
|
"path": "/file/v1/files/{file_id}",
|
|
7657
7947
|
"streaming": "no",
|
|
@@ -7668,7 +7958,7 @@ export const operations = [
|
|
|
7668
7958
|
"resource": "file.files",
|
|
7669
7959
|
"method": "retrieveContent",
|
|
7670
7960
|
"summary": "Retrieve file content",
|
|
7671
|
-
"description": "Download the original bytes of a live file owned by your tenant. Supply its
|
|
7961
|
+
"description": "Download the original bytes of a live file owned by your tenant. Supply its file- ID from upload or list. A single byte Range can return a partial response; a range outside the file returns 416. Missing, deleted, expired and other-tenant files return 404.",
|
|
7672
7962
|
"http": "GET",
|
|
7673
7963
|
"path": "/file/v1/files/{file_id}/content",
|
|
7674
7964
|
"streaming": "no",
|
|
@@ -7682,42 +7972,188 @@ export const operations = [
|
|
|
7682
7972
|
"query": []
|
|
7683
7973
|
},
|
|
7684
7974
|
{
|
|
7685
|
-
"resource": "
|
|
7686
|
-
"method": "
|
|
7687
|
-
"summary": "
|
|
7688
|
-
"description": "
|
|
7689
|
-
"http": "
|
|
7690
|
-
"path": "/
|
|
7975
|
+
"resource": "file.uploads",
|
|
7976
|
+
"method": "create",
|
|
7977
|
+
"summary": "Create an upload",
|
|
7978
|
+
"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 2 GiB (2147483648 bytes) and only user_data, assistants and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
|
|
7979
|
+
"http": "POST",
|
|
7980
|
+
"path": "/file/v1/uploads",
|
|
7691
7981
|
"streaming": "no",
|
|
7692
7982
|
"pagination": false,
|
|
7693
7983
|
"pathParams": [],
|
|
7694
|
-
"query": [
|
|
7695
|
-
|
|
7696
|
-
|
|
7697
|
-
|
|
7698
|
-
|
|
7699
|
-
"
|
|
7700
|
-
"
|
|
7701
|
-
|
|
7702
|
-
|
|
7703
|
-
|
|
7704
|
-
|
|
7705
|
-
|
|
7706
|
-
|
|
7707
|
-
|
|
7708
|
-
|
|
7709
|
-
|
|
7710
|
-
|
|
7711
|
-
|
|
7712
|
-
|
|
7713
|
-
|
|
7714
|
-
|
|
7715
|
-
|
|
7716
|
-
|
|
7717
|
-
|
|
7718
|
-
|
|
7719
|
-
|
|
7720
|
-
|
|
7984
|
+
"query": [],
|
|
7985
|
+
"body": {
|
|
7986
|
+
"required": true,
|
|
7987
|
+
"fields": [
|
|
7988
|
+
{
|
|
7989
|
+
"name": "bytes",
|
|
7990
|
+
"type": "integer",
|
|
7991
|
+
"required": true,
|
|
7992
|
+
"description": "Exact complete file length in bytes, from 1 through 2147483648 (2 GiB); the sum of completed parts must match."
|
|
7993
|
+
},
|
|
7994
|
+
{
|
|
7995
|
+
"name": "filename",
|
|
7996
|
+
"type": "string",
|
|
7997
|
+
"required": true,
|
|
7998
|
+
"description": "Filename for the resulting file, at most 255 UTF-8 bytes."
|
|
7999
|
+
},
|
|
8000
|
+
{
|
|
8001
|
+
"name": "mime_type",
|
|
8002
|
+
"type": "string",
|
|
8003
|
+
"required": true,
|
|
8004
|
+
"description": "Declared MIME type; validated against the assembled content."
|
|
8005
|
+
},
|
|
8006
|
+
{
|
|
8007
|
+
"name": "purpose",
|
|
8008
|
+
"type": "string",
|
|
8009
|
+
"enum": [
|
|
8010
|
+
"user_data",
|
|
8011
|
+
"assistants",
|
|
8012
|
+
"vision"
|
|
8013
|
+
],
|
|
8014
|
+
"required": true,
|
|
8015
|
+
"description": "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images."
|
|
8016
|
+
},
|
|
8017
|
+
{
|
|
8018
|
+
"name": "expires_after",
|
|
8019
|
+
"type": "object",
|
|
8020
|
+
"required": false,
|
|
8021
|
+
"description": "Optional expiry policy for the resulting file; omission retains the file until deletion."
|
|
8022
|
+
},
|
|
8023
|
+
{
|
|
8024
|
+
"name": "part_size",
|
|
8025
|
+
"type": "integer",
|
|
8026
|
+
"required": false,
|
|
8027
|
+
"description": "Optional fixed part size in bytes, 5242880–64000000. Requires part_number on every part; retries of identical bytes at the same number return the same part. Omit to use arbitrary-sized parts."
|
|
8028
|
+
}
|
|
8029
|
+
]
|
|
8030
|
+
}
|
|
8031
|
+
},
|
|
8032
|
+
{
|
|
8033
|
+
"resource": "file.uploads",
|
|
8034
|
+
"method": "cancel",
|
|
8035
|
+
"summary": "Cancel an upload",
|
|
8036
|
+
"description": "Cancel an unfinished upload using upload_id from create and release its reserved storage. Further parts and completion are rejected. Cancelling an already cancelled upload returns the same terminal result; a completed upload cannot be cancelled. Delete its resulting file instead.",
|
|
8037
|
+
"http": "POST",
|
|
8038
|
+
"path": "/file/v1/uploads/{upload_id}/cancel",
|
|
8039
|
+
"streaming": "no",
|
|
8040
|
+
"pagination": false,
|
|
8041
|
+
"pathParams": [
|
|
8042
|
+
{
|
|
8043
|
+
"name": "upload_id",
|
|
8044
|
+
"sdkName": "upload_id"
|
|
8045
|
+
}
|
|
8046
|
+
],
|
|
8047
|
+
"query": []
|
|
8048
|
+
},
|
|
8049
|
+
{
|
|
8050
|
+
"resource": "file.uploads",
|
|
8051
|
+
"method": "complete",
|
|
8052
|
+
"summary": "Complete an upload",
|
|
8053
|
+
"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.",
|
|
8054
|
+
"http": "POST",
|
|
8055
|
+
"path": "/file/v1/uploads/{upload_id}/complete",
|
|
8056
|
+
"streaming": "no",
|
|
8057
|
+
"pagination": false,
|
|
8058
|
+
"pathParams": [
|
|
8059
|
+
{
|
|
8060
|
+
"name": "upload_id",
|
|
8061
|
+
"sdkName": "upload_id"
|
|
8062
|
+
}
|
|
8063
|
+
],
|
|
8064
|
+
"query": [],
|
|
8065
|
+
"body": {
|
|
8066
|
+
"required": true,
|
|
8067
|
+
"fields": [
|
|
8068
|
+
{
|
|
8069
|
+
"name": "part_ids",
|
|
8070
|
+
"type": "array",
|
|
8071
|
+
"itemType": "string",
|
|
8072
|
+
"required": true,
|
|
8073
|
+
"description": "All part IDs in concatenation order, without duplicates. Fixed-size uploads require increasing part_number order."
|
|
8074
|
+
},
|
|
8075
|
+
{
|
|
8076
|
+
"name": "md5",
|
|
8077
|
+
"type": "string",
|
|
8078
|
+
"required": false,
|
|
8079
|
+
"description": "Optional whole-file MD5 as 32 hexadecimal characters; verified after assembly."
|
|
8080
|
+
}
|
|
8081
|
+
]
|
|
8082
|
+
}
|
|
8083
|
+
},
|
|
8084
|
+
{
|
|
8085
|
+
"resource": "file.uploads.parts",
|
|
8086
|
+
"method": "create",
|
|
8087
|
+
"summary": "Add an upload part",
|
|
8088
|
+
"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.",
|
|
8089
|
+
"http": "POST",
|
|
8090
|
+
"path": "/file/v1/uploads/{upload_id}/parts",
|
|
8091
|
+
"streaming": "no",
|
|
8092
|
+
"pagination": false,
|
|
8093
|
+
"multipart": true,
|
|
8094
|
+
"pathParams": [
|
|
8095
|
+
{
|
|
8096
|
+
"name": "upload_id",
|
|
8097
|
+
"sdkName": "upload_id"
|
|
8098
|
+
}
|
|
8099
|
+
],
|
|
8100
|
+
"query": [
|
|
8101
|
+
{
|
|
8102
|
+
"name": "part_number",
|
|
8103
|
+
"type": "integer",
|
|
8104
|
+
"required": false,
|
|
8105
|
+
"description": "Required when create set part_size; 1 through ceil(bytes / part_size). Ignored for general uploads."
|
|
8106
|
+
}
|
|
8107
|
+
],
|
|
8108
|
+
"body": {
|
|
8109
|
+
"required": true,
|
|
8110
|
+
"fields": [
|
|
8111
|
+
{
|
|
8112
|
+
"name": "data",
|
|
8113
|
+
"type": "string",
|
|
8114
|
+
"required": true,
|
|
8115
|
+
"description": "Raw bytes of this part, nonempty and at most 64000000 bytes."
|
|
8116
|
+
}
|
|
8117
|
+
]
|
|
8118
|
+
}
|
|
8119
|
+
},
|
|
8120
|
+
{
|
|
8121
|
+
"resource": "knowledge.vectorStores",
|
|
8122
|
+
"method": "list",
|
|
8123
|
+
"summary": "List knowledge bases",
|
|
8124
|
+
"description": "Lists knowledge bases visible to the caller, newest first by default. Use last_id as after to read the next page; for example, ?limit=20.",
|
|
8125
|
+
"http": "GET",
|
|
8126
|
+
"path": "/knowledge/v1/vector_stores",
|
|
8127
|
+
"streaming": "no",
|
|
8128
|
+
"pagination": false,
|
|
8129
|
+
"pathParams": [],
|
|
8130
|
+
"query": [
|
|
8131
|
+
{
|
|
8132
|
+
"name": "status",
|
|
8133
|
+
"type": "string",
|
|
8134
|
+
"enum": [
|
|
8135
|
+
"active",
|
|
8136
|
+
"deleting"
|
|
8137
|
+
],
|
|
8138
|
+
"required": false,
|
|
8139
|
+
"description": "active selects active stores; deleting selects soft-deleted stores awaiting purge. Omission excludes soft-deleted stores."
|
|
8140
|
+
},
|
|
8141
|
+
{
|
|
8142
|
+
"name": "after",
|
|
8143
|
+
"type": "string",
|
|
8144
|
+
"required": false,
|
|
8145
|
+
"description": "Cursor ID from the previous page."
|
|
8146
|
+
},
|
|
8147
|
+
{
|
|
8148
|
+
"name": "before",
|
|
8149
|
+
"type": "string",
|
|
8150
|
+
"required": false,
|
|
8151
|
+
"description": "Return items before this ID."
|
|
8152
|
+
},
|
|
8153
|
+
{
|
|
8154
|
+
"name": "limit",
|
|
8155
|
+
"type": "integer",
|
|
8156
|
+
"required": false,
|
|
7721
8157
|
"description": "Page size."
|
|
7722
8158
|
},
|
|
7723
8159
|
{
|
|
@@ -11811,7 +12247,7 @@ export const operations = [
|
|
|
11811
12247
|
"name": "message",
|
|
11812
12248
|
"type": "string",
|
|
11813
12249
|
"required": true,
|
|
11814
|
-
"description": "Problem description
|
|
12250
|
+
"description": "Problem description, at most 4096 Unicode code points; may be empty only when contexts.praxis.error.message is a non-empty string."
|
|
11815
12251
|
},
|
|
11816
12252
|
{
|
|
11817
12253
|
"name": "contact_email",
|
|
@@ -12109,7 +12545,7 @@ export const operations = [
|
|
|
12109
12545
|
"resource": "sandbox.sandboxes",
|
|
12110
12546
|
"method": "create",
|
|
12111
12547
|
"summary": "Create sandbox (v2)",
|
|
12112
|
-
"description": "
|
|
12548
|
+
"description": "Create a sandbox from the template. All system communication with the sandbox is secured.",
|
|
12113
12549
|
"http": "POST",
|
|
12114
12550
|
"path": "/sandbox/v1/sandboxes",
|
|
12115
12551
|
"streaming": "no",
|
|
@@ -12123,7 +12559,7 @@ export const operations = [
|
|
|
12123
12559
|
"name": "templateID",
|
|
12124
12560
|
"type": "string",
|
|
12125
12561
|
"required": true,
|
|
12126
|
-
"description": "
|
|
12562
|
+
"description": "Identifier of the required template"
|
|
12127
12563
|
},
|
|
12128
12564
|
{
|
|
12129
12565
|
"name": "timeout",
|
|
@@ -12261,7 +12697,7 @@ export const operations = [
|
|
|
12261
12697
|
"resource": "sandbox.sandboxes",
|
|
12262
12698
|
"method": "connect",
|
|
12263
12699
|
"summary": "Connect sandbox (v2)",
|
|
12264
|
-
"description": "
|
|
12700
|
+
"description": "Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is only extended. The request body is optional; an omitted timeout defaults to 300 seconds.",
|
|
12265
12701
|
"http": "POST",
|
|
12266
12702
|
"path": "/sandbox/v1/sandboxes/{sandboxID}/connect",
|
|
12267
12703
|
"streaming": "no",
|
|
@@ -12420,7 +12856,7 @@ export const operations = [
|
|
|
12420
12856
|
"resource": "sandbox.sandboxes.metrics",
|
|
12421
12857
|
"method": "list",
|
|
12422
12858
|
"summary": "Sandbox metrics",
|
|
12423
|
-
"description": "Read CPU, memory and disk usage over
|
|
12859
|
+
"description": "Read CPU, memory and disk usage samples of a sandbox over a time window. Use it to size a sandbox or find out why it is slow. start and end are Unix timestamps in seconds; without them the recent samples are returned. An unknown id answers 404.",
|
|
12424
12860
|
"http": "GET",
|
|
12425
12861
|
"path": "/sandbox/v1/sandboxes/{sandboxID}/metrics",
|
|
12426
12862
|
"streaming": "no",
|
|
@@ -12504,7 +12940,7 @@ export const operations = [
|
|
|
12504
12940
|
"resource": "sandbox.sandboxes",
|
|
12505
12941
|
"method": "pause",
|
|
12506
12942
|
"summary": "Pause sandbox",
|
|
12507
|
-
"description": "
|
|
12943
|
+
"description": "Pause a running sandbox, keeping its files and memory so that connectSandbox can resume it later. Use it to stop paying for compute without losing state; to discard the sandbox use killSandbox. Success answers 204. A sandbox that is not running answers 409.",
|
|
12508
12944
|
"http": "POST",
|
|
12509
12945
|
"path": "/sandbox/v1/sandboxes/{sandboxID}/pause",
|
|
12510
12946
|
"streaming": "no",
|
|
@@ -12896,7 +13332,7 @@ export const operations = [
|
|
|
12896
13332
|
"resource": "sandbox.templates",
|
|
12897
13333
|
"method": "list",
|
|
12898
13334
|
"summary": "List templates (v2)",
|
|
12899
|
-
"description": "
|
|
13335
|
+
"description": "List the templates you can create sandboxes from. Use it to pick the template id or alias for createSandbox. `base` is the default template that createSandbox uses when templateID is omitted. limit is 1 to 100 (default 100); send the cursor from the response back as nextToken to continue.",
|
|
12900
13336
|
"http": "GET",
|
|
12901
13337
|
"path": "/sandbox/v1/templates",
|
|
12902
13338
|
"streaming": "no",
|
|
@@ -13657,6 +14093,1466 @@ export const operations = [
|
|
|
13657
14093
|
]
|
|
13658
14094
|
}
|
|
13659
14095
|
},
|
|
14096
|
+
{
|
|
14097
|
+
"resource": "ticket.activity",
|
|
14098
|
+
"method": "retrieve",
|
|
14099
|
+
"summary": "List activity",
|
|
14100
|
+
"description": "List activity within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14101
|
+
"http": "GET",
|
|
14102
|
+
"path": "/ticket/v1/activity",
|
|
14103
|
+
"streaming": "no",
|
|
14104
|
+
"pagination": false,
|
|
14105
|
+
"pathParams": [],
|
|
14106
|
+
"query": [
|
|
14107
|
+
{
|
|
14108
|
+
"name": "repository",
|
|
14109
|
+
"type": "string",
|
|
14110
|
+
"required": false,
|
|
14111
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14112
|
+
},
|
|
14113
|
+
{
|
|
14114
|
+
"name": "page_size",
|
|
14115
|
+
"type": "integer",
|
|
14116
|
+
"required": false,
|
|
14117
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14118
|
+
},
|
|
14119
|
+
{
|
|
14120
|
+
"name": "page_token",
|
|
14121
|
+
"type": "string",
|
|
14122
|
+
"required": false,
|
|
14123
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14124
|
+
},
|
|
14125
|
+
{
|
|
14126
|
+
"name": "filter",
|
|
14127
|
+
"type": "string",
|
|
14128
|
+
"required": false,
|
|
14129
|
+
"description": "Activity qualifiers: actor, actor-kind, action, ticket, source and since; passed unchanged to the service."
|
|
14130
|
+
}
|
|
14131
|
+
]
|
|
14132
|
+
},
|
|
14133
|
+
{
|
|
14134
|
+
"resource": "ticket.comments",
|
|
14135
|
+
"method": "delete",
|
|
14136
|
+
"summary": "Remove comments",
|
|
14137
|
+
"description": "Remove comments 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.",
|
|
14138
|
+
"http": "DELETE",
|
|
14139
|
+
"path": "/ticket/v1/comments/{id}",
|
|
14140
|
+
"streaming": "no",
|
|
14141
|
+
"pagination": false,
|
|
14142
|
+
"pathParams": [
|
|
14143
|
+
{
|
|
14144
|
+
"name": "id",
|
|
14145
|
+
"sdkName": "id"
|
|
14146
|
+
}
|
|
14147
|
+
],
|
|
14148
|
+
"query": [
|
|
14149
|
+
{
|
|
14150
|
+
"name": "repository",
|
|
14151
|
+
"type": "string",
|
|
14152
|
+
"required": false,
|
|
14153
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14154
|
+
}
|
|
14155
|
+
]
|
|
14156
|
+
},
|
|
14157
|
+
{
|
|
14158
|
+
"resource": "ticket.comments",
|
|
14159
|
+
"method": "retrieve",
|
|
14160
|
+
"summary": "Read comments",
|
|
14161
|
+
"description": "Read comments 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.",
|
|
14162
|
+
"http": "GET",
|
|
14163
|
+
"path": "/ticket/v1/comments/{id}",
|
|
14164
|
+
"streaming": "no",
|
|
14165
|
+
"pagination": false,
|
|
14166
|
+
"pathParams": [
|
|
14167
|
+
{
|
|
14168
|
+
"name": "id",
|
|
14169
|
+
"sdkName": "id"
|
|
14170
|
+
}
|
|
14171
|
+
],
|
|
14172
|
+
"query": [
|
|
14173
|
+
{
|
|
14174
|
+
"name": "repository",
|
|
14175
|
+
"type": "string",
|
|
14176
|
+
"required": false,
|
|
14177
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14178
|
+
}
|
|
14179
|
+
]
|
|
14180
|
+
},
|
|
14181
|
+
{
|
|
14182
|
+
"resource": "ticket.comments",
|
|
14183
|
+
"method": "update",
|
|
14184
|
+
"summary": "Update comments",
|
|
14185
|
+
"description": "Update comments 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.",
|
|
14186
|
+
"http": "PATCH",
|
|
14187
|
+
"path": "/ticket/v1/comments/{id}",
|
|
14188
|
+
"streaming": "no",
|
|
14189
|
+
"pagination": false,
|
|
14190
|
+
"pathParams": [
|
|
14191
|
+
{
|
|
14192
|
+
"name": "id",
|
|
14193
|
+
"sdkName": "id"
|
|
14194
|
+
}
|
|
14195
|
+
],
|
|
14196
|
+
"query": [
|
|
14197
|
+
{
|
|
14198
|
+
"name": "repository",
|
|
14199
|
+
"type": "string",
|
|
14200
|
+
"required": false,
|
|
14201
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14202
|
+
}
|
|
14203
|
+
],
|
|
14204
|
+
"body": {
|
|
14205
|
+
"required": true,
|
|
14206
|
+
"fields": [
|
|
14207
|
+
{
|
|
14208
|
+
"name": "body",
|
|
14209
|
+
"type": "string",
|
|
14210
|
+
"required": true,
|
|
14211
|
+
"description": "Markdown text, at most 65536 characters."
|
|
14212
|
+
},
|
|
14213
|
+
{
|
|
14214
|
+
"name": "in_reply_to",
|
|
14215
|
+
"type": "string",
|
|
14216
|
+
"required": false,
|
|
14217
|
+
"description": "Opaque identifier returned by this resource's create or list operation."
|
|
14218
|
+
}
|
|
14219
|
+
]
|
|
14220
|
+
}
|
|
14221
|
+
},
|
|
14222
|
+
{
|
|
14223
|
+
"resource": "ticket.comments.reactions",
|
|
14224
|
+
"method": "list",
|
|
14225
|
+
"summary": "List reactions",
|
|
14226
|
+
"description": "List reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14227
|
+
"http": "GET",
|
|
14228
|
+
"path": "/ticket/v1/comments/{id}/reactions",
|
|
14229
|
+
"streaming": "no",
|
|
14230
|
+
"pagination": false,
|
|
14231
|
+
"pathParams": [
|
|
14232
|
+
{
|
|
14233
|
+
"name": "id",
|
|
14234
|
+
"sdkName": "id"
|
|
14235
|
+
}
|
|
14236
|
+
],
|
|
14237
|
+
"query": [
|
|
14238
|
+
{
|
|
14239
|
+
"name": "repository",
|
|
14240
|
+
"type": "string",
|
|
14241
|
+
"required": false,
|
|
14242
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14243
|
+
},
|
|
14244
|
+
{
|
|
14245
|
+
"name": "page_size",
|
|
14246
|
+
"type": "integer",
|
|
14247
|
+
"required": false,
|
|
14248
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14249
|
+
},
|
|
14250
|
+
{
|
|
14251
|
+
"name": "page_token",
|
|
14252
|
+
"type": "string",
|
|
14253
|
+
"required": false,
|
|
14254
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14255
|
+
}
|
|
14256
|
+
]
|
|
14257
|
+
},
|
|
14258
|
+
{
|
|
14259
|
+
"resource": "ticket.comments.reactions",
|
|
14260
|
+
"method": "create",
|
|
14261
|
+
"summary": "Create or add reactions",
|
|
14262
|
+
"description": "Create or add reactions 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.",
|
|
14263
|
+
"http": "POST",
|
|
14264
|
+
"path": "/ticket/v1/comments/{id}/reactions",
|
|
14265
|
+
"streaming": "no",
|
|
14266
|
+
"pagination": false,
|
|
14267
|
+
"pathParams": [
|
|
14268
|
+
{
|
|
14269
|
+
"name": "id",
|
|
14270
|
+
"sdkName": "id"
|
|
14271
|
+
}
|
|
14272
|
+
],
|
|
14273
|
+
"query": [
|
|
14274
|
+
{
|
|
14275
|
+
"name": "repository",
|
|
14276
|
+
"type": "string",
|
|
14277
|
+
"required": false,
|
|
14278
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14279
|
+
}
|
|
14280
|
+
],
|
|
14281
|
+
"body": {
|
|
14282
|
+
"required": true,
|
|
14283
|
+
"fields": [
|
|
14284
|
+
{
|
|
14285
|
+
"name": "content",
|
|
14286
|
+
"type": "string",
|
|
14287
|
+
"enum": [
|
|
14288
|
+
"+1",
|
|
14289
|
+
"-1",
|
|
14290
|
+
"laugh",
|
|
14291
|
+
"confused",
|
|
14292
|
+
"heart",
|
|
14293
|
+
"hooray",
|
|
14294
|
+
"eyes",
|
|
14295
|
+
"rocket"
|
|
14296
|
+
],
|
|
14297
|
+
"required": true,
|
|
14298
|
+
"description": "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket."
|
|
14299
|
+
}
|
|
14300
|
+
]
|
|
14301
|
+
}
|
|
14302
|
+
},
|
|
14303
|
+
{
|
|
14304
|
+
"resource": "ticket.comments.reactions",
|
|
14305
|
+
"method": "delete",
|
|
14306
|
+
"summary": "Remove reactions",
|
|
14307
|
+
"description": "Remove reactions 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.",
|
|
14308
|
+
"http": "DELETE",
|
|
14309
|
+
"path": "/ticket/v1/comments/{id}/reactions/{content}",
|
|
14310
|
+
"streaming": "no",
|
|
14311
|
+
"pagination": false,
|
|
14312
|
+
"pathParams": [
|
|
14313
|
+
{
|
|
14314
|
+
"name": "id",
|
|
14315
|
+
"sdkName": "id"
|
|
14316
|
+
},
|
|
14317
|
+
{
|
|
14318
|
+
"name": "content",
|
|
14319
|
+
"sdkName": "content"
|
|
14320
|
+
}
|
|
14321
|
+
],
|
|
14322
|
+
"query": [
|
|
14323
|
+
{
|
|
14324
|
+
"name": "repository",
|
|
14325
|
+
"type": "string",
|
|
14326
|
+
"required": false,
|
|
14327
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14328
|
+
}
|
|
14329
|
+
]
|
|
14330
|
+
},
|
|
14331
|
+
{
|
|
14332
|
+
"resource": "ticket.labels",
|
|
14333
|
+
"method": "list",
|
|
14334
|
+
"summary": "List labels",
|
|
14335
|
+
"description": "List labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14336
|
+
"http": "GET",
|
|
14337
|
+
"path": "/ticket/v1/labels",
|
|
14338
|
+
"streaming": "no",
|
|
14339
|
+
"pagination": false,
|
|
14340
|
+
"pathParams": [],
|
|
14341
|
+
"query": [
|
|
14342
|
+
{
|
|
14343
|
+
"name": "repository",
|
|
14344
|
+
"type": "string",
|
|
14345
|
+
"required": false,
|
|
14346
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14347
|
+
},
|
|
14348
|
+
{
|
|
14349
|
+
"name": "page_size",
|
|
14350
|
+
"type": "integer",
|
|
14351
|
+
"required": false,
|
|
14352
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14353
|
+
},
|
|
14354
|
+
{
|
|
14355
|
+
"name": "page_token",
|
|
14356
|
+
"type": "string",
|
|
14357
|
+
"required": false,
|
|
14358
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14359
|
+
}
|
|
14360
|
+
]
|
|
14361
|
+
},
|
|
14362
|
+
{
|
|
14363
|
+
"resource": "ticket.labels",
|
|
14364
|
+
"method": "create",
|
|
14365
|
+
"summary": "Create or add labels",
|
|
14366
|
+
"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. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14367
|
+
"http": "POST",
|
|
14368
|
+
"path": "/ticket/v1/labels",
|
|
14369
|
+
"streaming": "no",
|
|
14370
|
+
"pagination": false,
|
|
14371
|
+
"pathParams": [],
|
|
14372
|
+
"query": [
|
|
14373
|
+
{
|
|
14374
|
+
"name": "repository",
|
|
14375
|
+
"type": "string",
|
|
14376
|
+
"required": false,
|
|
14377
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14378
|
+
}
|
|
14379
|
+
],
|
|
14380
|
+
"body": {
|
|
14381
|
+
"required": true,
|
|
14382
|
+
"fields": [
|
|
14383
|
+
{
|
|
14384
|
+
"name": "name",
|
|
14385
|
+
"type": "string",
|
|
14386
|
+
"required": true,
|
|
14387
|
+
"description": "Case-insensitive label name within the repository."
|
|
14388
|
+
},
|
|
14389
|
+
{
|
|
14390
|
+
"name": "color",
|
|
14391
|
+
"type": "string",
|
|
14392
|
+
"required": true,
|
|
14393
|
+
"description": "Six hexadecimal digits without #."
|
|
14394
|
+
},
|
|
14395
|
+
{
|
|
14396
|
+
"name": "description",
|
|
14397
|
+
"type": "string",
|
|
14398
|
+
"required": false,
|
|
14399
|
+
"description": "Label's purpose."
|
|
14400
|
+
}
|
|
14401
|
+
]
|
|
14402
|
+
}
|
|
14403
|
+
},
|
|
14404
|
+
{
|
|
14405
|
+
"resource": "ticket.labels",
|
|
14406
|
+
"method": "delete",
|
|
14407
|
+
"summary": "Remove labels",
|
|
14408
|
+
"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. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14409
|
+
"http": "DELETE",
|
|
14410
|
+
"path": "/ticket/v1/labels/{name}",
|
|
14411
|
+
"streaming": "no",
|
|
14412
|
+
"pagination": false,
|
|
14413
|
+
"pathParams": [
|
|
14414
|
+
{
|
|
14415
|
+
"name": "name",
|
|
14416
|
+
"sdkName": "name"
|
|
14417
|
+
}
|
|
14418
|
+
],
|
|
14419
|
+
"query": [
|
|
14420
|
+
{
|
|
14421
|
+
"name": "repository",
|
|
14422
|
+
"type": "string",
|
|
14423
|
+
"required": false,
|
|
14424
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14425
|
+
}
|
|
14426
|
+
]
|
|
14427
|
+
},
|
|
14428
|
+
{
|
|
14429
|
+
"resource": "ticket.labels",
|
|
14430
|
+
"method": "update",
|
|
14431
|
+
"summary": "Update labels",
|
|
14432
|
+
"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. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14433
|
+
"http": "PATCH",
|
|
14434
|
+
"path": "/ticket/v1/labels/{name}",
|
|
14435
|
+
"streaming": "no",
|
|
14436
|
+
"pagination": false,
|
|
14437
|
+
"pathParams": [
|
|
14438
|
+
{
|
|
14439
|
+
"name": "name",
|
|
14440
|
+
"sdkName": "name"
|
|
14441
|
+
}
|
|
14442
|
+
],
|
|
14443
|
+
"query": [
|
|
14444
|
+
{
|
|
14445
|
+
"name": "repository",
|
|
14446
|
+
"type": "string",
|
|
14447
|
+
"required": false,
|
|
14448
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14449
|
+
}
|
|
14450
|
+
],
|
|
14451
|
+
"body": {
|
|
14452
|
+
"required": true,
|
|
14453
|
+
"fields": [
|
|
14454
|
+
{
|
|
14455
|
+
"name": "color",
|
|
14456
|
+
"type": "string",
|
|
14457
|
+
"required": false,
|
|
14458
|
+
"description": "Six hexadecimal digits without #."
|
|
14459
|
+
},
|
|
14460
|
+
{
|
|
14461
|
+
"name": "description",
|
|
14462
|
+
"type": "string",
|
|
14463
|
+
"required": false,
|
|
14464
|
+
"description": "Label's purpose."
|
|
14465
|
+
},
|
|
14466
|
+
{
|
|
14467
|
+
"name": "new_name",
|
|
14468
|
+
"type": "string",
|
|
14469
|
+
"required": false,
|
|
14470
|
+
"description": "Case-insensitive label name within the repository."
|
|
14471
|
+
}
|
|
14472
|
+
]
|
|
14473
|
+
}
|
|
14474
|
+
},
|
|
14475
|
+
{
|
|
14476
|
+
"resource": "ticket.milestones",
|
|
14477
|
+
"method": "list",
|
|
14478
|
+
"summary": "List milestones",
|
|
14479
|
+
"description": "List milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14480
|
+
"http": "GET",
|
|
14481
|
+
"path": "/ticket/v1/milestones",
|
|
14482
|
+
"streaming": "no",
|
|
14483
|
+
"pagination": false,
|
|
14484
|
+
"pathParams": [],
|
|
14485
|
+
"query": [
|
|
14486
|
+
{
|
|
14487
|
+
"name": "repository",
|
|
14488
|
+
"type": "string",
|
|
14489
|
+
"required": false,
|
|
14490
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14491
|
+
},
|
|
14492
|
+
{
|
|
14493
|
+
"name": "page_size",
|
|
14494
|
+
"type": "integer",
|
|
14495
|
+
"required": false,
|
|
14496
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14497
|
+
},
|
|
14498
|
+
{
|
|
14499
|
+
"name": "page_token",
|
|
14500
|
+
"type": "string",
|
|
14501
|
+
"required": false,
|
|
14502
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14503
|
+
}
|
|
14504
|
+
]
|
|
14505
|
+
},
|
|
14506
|
+
{
|
|
14507
|
+
"resource": "ticket.milestones",
|
|
14508
|
+
"method": "create",
|
|
14509
|
+
"summary": "Create or add milestones",
|
|
14510
|
+
"description": "Create or add milestones 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. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14511
|
+
"http": "POST",
|
|
14512
|
+
"path": "/ticket/v1/milestones",
|
|
14513
|
+
"streaming": "no",
|
|
14514
|
+
"pagination": false,
|
|
14515
|
+
"pathParams": [],
|
|
14516
|
+
"query": [
|
|
14517
|
+
{
|
|
14518
|
+
"name": "repository",
|
|
14519
|
+
"type": "string",
|
|
14520
|
+
"required": false,
|
|
14521
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14522
|
+
}
|
|
14523
|
+
],
|
|
14524
|
+
"body": {
|
|
14525
|
+
"required": true,
|
|
14526
|
+
"fields": [
|
|
14527
|
+
{
|
|
14528
|
+
"name": "title",
|
|
14529
|
+
"type": "string",
|
|
14530
|
+
"required": true,
|
|
14531
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
14532
|
+
},
|
|
14533
|
+
{
|
|
14534
|
+
"name": "description",
|
|
14535
|
+
"type": "string",
|
|
14536
|
+
"required": false,
|
|
14537
|
+
"description": "Milestone description."
|
|
14538
|
+
},
|
|
14539
|
+
{
|
|
14540
|
+
"name": "due_on",
|
|
14541
|
+
"type": "string",
|
|
14542
|
+
"required": false,
|
|
14543
|
+
"description": "Due date, or null if unset."
|
|
14544
|
+
},
|
|
14545
|
+
{
|
|
14546
|
+
"name": "state",
|
|
14547
|
+
"type": "string",
|
|
14548
|
+
"enum": [
|
|
14549
|
+
"open",
|
|
14550
|
+
"closed"
|
|
14551
|
+
],
|
|
14552
|
+
"required": false,
|
|
14553
|
+
"description": "open means actionable; closed means resolved or declined."
|
|
14554
|
+
}
|
|
14555
|
+
]
|
|
14556
|
+
}
|
|
14557
|
+
},
|
|
14558
|
+
{
|
|
14559
|
+
"resource": "ticket.milestones",
|
|
14560
|
+
"method": "delete",
|
|
14561
|
+
"summary": "Remove milestones",
|
|
14562
|
+
"description": "Remove milestones 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. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14563
|
+
"http": "DELETE",
|
|
14564
|
+
"path": "/ticket/v1/milestones/{number}",
|
|
14565
|
+
"streaming": "no",
|
|
14566
|
+
"pagination": false,
|
|
14567
|
+
"pathParams": [
|
|
14568
|
+
{
|
|
14569
|
+
"name": "number",
|
|
14570
|
+
"sdkName": "number"
|
|
14571
|
+
}
|
|
14572
|
+
],
|
|
14573
|
+
"query": [
|
|
14574
|
+
{
|
|
14575
|
+
"name": "repository",
|
|
14576
|
+
"type": "string",
|
|
14577
|
+
"required": false,
|
|
14578
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14579
|
+
}
|
|
14580
|
+
]
|
|
14581
|
+
},
|
|
14582
|
+
{
|
|
14583
|
+
"resource": "ticket.milestones",
|
|
14584
|
+
"method": "retrieve",
|
|
14585
|
+
"summary": "Read milestones",
|
|
14586
|
+
"description": "Read milestones 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.",
|
|
14587
|
+
"http": "GET",
|
|
14588
|
+
"path": "/ticket/v1/milestones/{number}",
|
|
14589
|
+
"streaming": "no",
|
|
14590
|
+
"pagination": false,
|
|
14591
|
+
"pathParams": [
|
|
14592
|
+
{
|
|
14593
|
+
"name": "number",
|
|
14594
|
+
"sdkName": "number"
|
|
14595
|
+
}
|
|
14596
|
+
],
|
|
14597
|
+
"query": [
|
|
14598
|
+
{
|
|
14599
|
+
"name": "repository",
|
|
14600
|
+
"type": "string",
|
|
14601
|
+
"required": false,
|
|
14602
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14603
|
+
}
|
|
14604
|
+
]
|
|
14605
|
+
},
|
|
14606
|
+
{
|
|
14607
|
+
"resource": "ticket.milestones",
|
|
14608
|
+
"method": "update",
|
|
14609
|
+
"summary": "Update milestones",
|
|
14610
|
+
"description": "Update milestones 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. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14611
|
+
"http": "PATCH",
|
|
14612
|
+
"path": "/ticket/v1/milestones/{number}",
|
|
14613
|
+
"streaming": "no",
|
|
14614
|
+
"pagination": false,
|
|
14615
|
+
"pathParams": [
|
|
14616
|
+
{
|
|
14617
|
+
"name": "number",
|
|
14618
|
+
"sdkName": "number"
|
|
14619
|
+
}
|
|
14620
|
+
],
|
|
14621
|
+
"query": [
|
|
14622
|
+
{
|
|
14623
|
+
"name": "repository",
|
|
14624
|
+
"type": "string",
|
|
14625
|
+
"required": false,
|
|
14626
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14627
|
+
}
|
|
14628
|
+
],
|
|
14629
|
+
"body": {
|
|
14630
|
+
"required": true,
|
|
14631
|
+
"fields": [
|
|
14632
|
+
{
|
|
14633
|
+
"name": "title",
|
|
14634
|
+
"type": "string",
|
|
14635
|
+
"required": false,
|
|
14636
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
14637
|
+
},
|
|
14638
|
+
{
|
|
14639
|
+
"name": "description",
|
|
14640
|
+
"type": "string",
|
|
14641
|
+
"required": false,
|
|
14642
|
+
"description": "Milestone description."
|
|
14643
|
+
},
|
|
14644
|
+
{
|
|
14645
|
+
"name": "due_on",
|
|
14646
|
+
"type": "string",
|
|
14647
|
+
"required": false,
|
|
14648
|
+
"description": "Due date, or null if unset."
|
|
14649
|
+
},
|
|
14650
|
+
{
|
|
14651
|
+
"name": "state",
|
|
14652
|
+
"type": "string",
|
|
14653
|
+
"enum": [
|
|
14654
|
+
"open",
|
|
14655
|
+
"closed"
|
|
14656
|
+
],
|
|
14657
|
+
"required": false,
|
|
14658
|
+
"description": "open means actionable; closed means resolved or declined."
|
|
14659
|
+
}
|
|
14660
|
+
]
|
|
14661
|
+
}
|
|
14662
|
+
},
|
|
14663
|
+
{
|
|
14664
|
+
"resource": "ticket.repositories",
|
|
14665
|
+
"method": "list",
|
|
14666
|
+
"summary": "List repositories",
|
|
14667
|
+
"description": "List repositories within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14668
|
+
"http": "GET",
|
|
14669
|
+
"path": "/ticket/v1/repositories",
|
|
14670
|
+
"streaming": "no",
|
|
14671
|
+
"pagination": false,
|
|
14672
|
+
"pathParams": [],
|
|
14673
|
+
"query": [
|
|
14674
|
+
{
|
|
14675
|
+
"name": "page_size",
|
|
14676
|
+
"type": "integer",
|
|
14677
|
+
"required": false,
|
|
14678
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14679
|
+
},
|
|
14680
|
+
{
|
|
14681
|
+
"name": "page_token",
|
|
14682
|
+
"type": "string",
|
|
14683
|
+
"required": false,
|
|
14684
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14685
|
+
}
|
|
14686
|
+
]
|
|
14687
|
+
},
|
|
14688
|
+
{
|
|
14689
|
+
"resource": "ticket.tickets",
|
|
14690
|
+
"method": "list",
|
|
14691
|
+
"summary": "List tickets",
|
|
14692
|
+
"description": "List tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14693
|
+
"http": "GET",
|
|
14694
|
+
"path": "/ticket/v1/tickets",
|
|
14695
|
+
"streaming": "no",
|
|
14696
|
+
"pagination": false,
|
|
14697
|
+
"pathParams": [],
|
|
14698
|
+
"query": [
|
|
14699
|
+
{
|
|
14700
|
+
"name": "repository",
|
|
14701
|
+
"type": "string",
|
|
14702
|
+
"required": false,
|
|
14703
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14704
|
+
},
|
|
14705
|
+
{
|
|
14706
|
+
"name": "page_size",
|
|
14707
|
+
"type": "integer",
|
|
14708
|
+
"required": false,
|
|
14709
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14710
|
+
},
|
|
14711
|
+
{
|
|
14712
|
+
"name": "page_token",
|
|
14713
|
+
"type": "string",
|
|
14714
|
+
"required": false,
|
|
14715
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14716
|
+
},
|
|
14717
|
+
{
|
|
14718
|
+
"name": "filter",
|
|
14719
|
+
"type": "string",
|
|
14720
|
+
"required": false,
|
|
14721
|
+
"description": "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort; unknown qualifiers return INVALID_PARAMS. Passed unchanged to the service."
|
|
14722
|
+
}
|
|
14723
|
+
]
|
|
14724
|
+
},
|
|
14725
|
+
{
|
|
14726
|
+
"resource": "ticket.tickets",
|
|
14727
|
+
"method": "create",
|
|
14728
|
+
"summary": "Create or add tickets",
|
|
14729
|
+
"description": "Create or add tickets 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.",
|
|
14730
|
+
"http": "POST",
|
|
14731
|
+
"path": "/ticket/v1/tickets",
|
|
14732
|
+
"streaming": "no",
|
|
14733
|
+
"pagination": false,
|
|
14734
|
+
"pathParams": [],
|
|
14735
|
+
"query": [
|
|
14736
|
+
{
|
|
14737
|
+
"name": "repository",
|
|
14738
|
+
"type": "string",
|
|
14739
|
+
"required": false,
|
|
14740
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14741
|
+
}
|
|
14742
|
+
],
|
|
14743
|
+
"body": {
|
|
14744
|
+
"required": true,
|
|
14745
|
+
"fields": [
|
|
14746
|
+
{
|
|
14747
|
+
"name": "title",
|
|
14748
|
+
"type": "string",
|
|
14749
|
+
"required": true,
|
|
14750
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
14751
|
+
},
|
|
14752
|
+
{
|
|
14753
|
+
"name": "body",
|
|
14754
|
+
"type": "string",
|
|
14755
|
+
"required": false,
|
|
14756
|
+
"description": "Markdown text, at most 65536 characters."
|
|
14757
|
+
},
|
|
14758
|
+
{
|
|
14759
|
+
"name": "type",
|
|
14760
|
+
"type": "string",
|
|
14761
|
+
"required": false,
|
|
14762
|
+
"description": "Built-in type name; null clears an existing type."
|
|
14763
|
+
},
|
|
14764
|
+
{
|
|
14765
|
+
"name": "labels",
|
|
14766
|
+
"type": "array",
|
|
14767
|
+
"itemType": "string",
|
|
14768
|
+
"required": false,
|
|
14769
|
+
"description": "Labels attached to this ticket; updates replace the complete list."
|
|
14770
|
+
},
|
|
14771
|
+
{
|
|
14772
|
+
"name": "assignees",
|
|
14773
|
+
"type": "array",
|
|
14774
|
+
"itemType": "string",
|
|
14775
|
+
"required": false,
|
|
14776
|
+
"description": "Complete assignee list, at most ten."
|
|
14777
|
+
},
|
|
14778
|
+
{
|
|
14779
|
+
"name": "milestone",
|
|
14780
|
+
"type": "integer",
|
|
14781
|
+
"required": false,
|
|
14782
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
14783
|
+
},
|
|
14784
|
+
{
|
|
14785
|
+
"name": "parent",
|
|
14786
|
+
"type": "integer",
|
|
14787
|
+
"required": false,
|
|
14788
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
14789
|
+
}
|
|
14790
|
+
]
|
|
14791
|
+
}
|
|
14792
|
+
},
|
|
14793
|
+
{
|
|
14794
|
+
"resource": "ticket.tickets",
|
|
14795
|
+
"method": "retrieve",
|
|
14796
|
+
"summary": "Read tickets",
|
|
14797
|
+
"description": "Read tickets 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.",
|
|
14798
|
+
"http": "GET",
|
|
14799
|
+
"path": "/ticket/v1/tickets/{number}",
|
|
14800
|
+
"streaming": "no",
|
|
14801
|
+
"pagination": false,
|
|
14802
|
+
"pathParams": [
|
|
14803
|
+
{
|
|
14804
|
+
"name": "number",
|
|
14805
|
+
"sdkName": "number"
|
|
14806
|
+
}
|
|
14807
|
+
],
|
|
14808
|
+
"query": [
|
|
14809
|
+
{
|
|
14810
|
+
"name": "repository",
|
|
14811
|
+
"type": "string",
|
|
14812
|
+
"required": false,
|
|
14813
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14814
|
+
}
|
|
14815
|
+
]
|
|
14816
|
+
},
|
|
14817
|
+
{
|
|
14818
|
+
"resource": "ticket.tickets",
|
|
14819
|
+
"method": "update",
|
|
14820
|
+
"summary": "Update tickets",
|
|
14821
|
+
"description": "Update tickets 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.",
|
|
14822
|
+
"http": "PATCH",
|
|
14823
|
+
"path": "/ticket/v1/tickets/{number}",
|
|
14824
|
+
"streaming": "no",
|
|
14825
|
+
"pagination": false,
|
|
14826
|
+
"pathParams": [
|
|
14827
|
+
{
|
|
14828
|
+
"name": "number",
|
|
14829
|
+
"sdkName": "number"
|
|
14830
|
+
}
|
|
14831
|
+
],
|
|
14832
|
+
"query": [
|
|
14833
|
+
{
|
|
14834
|
+
"name": "repository",
|
|
14835
|
+
"type": "string",
|
|
14836
|
+
"required": false,
|
|
14837
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14838
|
+
}
|
|
14839
|
+
],
|
|
14840
|
+
"body": {
|
|
14841
|
+
"required": true,
|
|
14842
|
+
"fields": [
|
|
14843
|
+
{
|
|
14844
|
+
"name": "title",
|
|
14845
|
+
"type": "string",
|
|
14846
|
+
"required": false,
|
|
14847
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
14848
|
+
},
|
|
14849
|
+
{
|
|
14850
|
+
"name": "body",
|
|
14851
|
+
"type": "string",
|
|
14852
|
+
"required": false,
|
|
14853
|
+
"description": "Markdown text, at most 65536 characters."
|
|
14854
|
+
},
|
|
14855
|
+
{
|
|
14856
|
+
"name": "type",
|
|
14857
|
+
"type": "string",
|
|
14858
|
+
"required": false,
|
|
14859
|
+
"description": "Built-in type name; null clears an existing type."
|
|
14860
|
+
},
|
|
14861
|
+
{
|
|
14862
|
+
"name": "labels",
|
|
14863
|
+
"type": "array",
|
|
14864
|
+
"itemType": "string",
|
|
14865
|
+
"required": false,
|
|
14866
|
+
"description": "Labels attached to this ticket; updates replace the complete list."
|
|
14867
|
+
},
|
|
14868
|
+
{
|
|
14869
|
+
"name": "assignees",
|
|
14870
|
+
"type": "array",
|
|
14871
|
+
"itemType": "string",
|
|
14872
|
+
"required": false,
|
|
14873
|
+
"description": "Complete assignee list, at most ten."
|
|
14874
|
+
},
|
|
14875
|
+
{
|
|
14876
|
+
"name": "milestone",
|
|
14877
|
+
"type": "integer",
|
|
14878
|
+
"required": false,
|
|
14879
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
14880
|
+
},
|
|
14881
|
+
{
|
|
14882
|
+
"name": "state",
|
|
14883
|
+
"type": "string",
|
|
14884
|
+
"enum": [
|
|
14885
|
+
"open",
|
|
14886
|
+
"closed"
|
|
14887
|
+
],
|
|
14888
|
+
"required": false,
|
|
14889
|
+
"description": "open means actionable; closed means resolved or declined."
|
|
14890
|
+
},
|
|
14891
|
+
{
|
|
14892
|
+
"name": "state_reason",
|
|
14893
|
+
"type": "string",
|
|
14894
|
+
"enum": [
|
|
14895
|
+
"completed",
|
|
14896
|
+
"not_planned",
|
|
14897
|
+
"duplicate"
|
|
14898
|
+
],
|
|
14899
|
+
"required": false,
|
|
14900
|
+
"description": "Reason for closing: completed resolves, not_planned declines, duplicate marks a duplicate."
|
|
14901
|
+
},
|
|
14902
|
+
{
|
|
14903
|
+
"name": "duplicate_of",
|
|
14904
|
+
"type": "integer",
|
|
14905
|
+
"required": false,
|
|
14906
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
14907
|
+
}
|
|
14908
|
+
]
|
|
14909
|
+
}
|
|
14910
|
+
},
|
|
14911
|
+
{
|
|
14912
|
+
"resource": "ticket.tickets.comments",
|
|
14913
|
+
"method": "list",
|
|
14914
|
+
"summary": "List comments",
|
|
14915
|
+
"description": "List comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14916
|
+
"http": "GET",
|
|
14917
|
+
"path": "/ticket/v1/tickets/{number}/comments",
|
|
14918
|
+
"streaming": "no",
|
|
14919
|
+
"pagination": false,
|
|
14920
|
+
"pathParams": [
|
|
14921
|
+
{
|
|
14922
|
+
"name": "number",
|
|
14923
|
+
"sdkName": "number"
|
|
14924
|
+
}
|
|
14925
|
+
],
|
|
14926
|
+
"query": [
|
|
14927
|
+
{
|
|
14928
|
+
"name": "repository",
|
|
14929
|
+
"type": "string",
|
|
14930
|
+
"required": false,
|
|
14931
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14932
|
+
},
|
|
14933
|
+
{
|
|
14934
|
+
"name": "page_size",
|
|
14935
|
+
"type": "integer",
|
|
14936
|
+
"required": false,
|
|
14937
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14938
|
+
},
|
|
14939
|
+
{
|
|
14940
|
+
"name": "page_token",
|
|
14941
|
+
"type": "string",
|
|
14942
|
+
"required": false,
|
|
14943
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14944
|
+
}
|
|
14945
|
+
]
|
|
14946
|
+
},
|
|
14947
|
+
{
|
|
14948
|
+
"resource": "ticket.tickets.comments",
|
|
14949
|
+
"method": "create",
|
|
14950
|
+
"summary": "Create or add comments",
|
|
14951
|
+
"description": "Create or add comments 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.",
|
|
14952
|
+
"http": "POST",
|
|
14953
|
+
"path": "/ticket/v1/tickets/{number}/comments",
|
|
14954
|
+
"streaming": "no",
|
|
14955
|
+
"pagination": false,
|
|
14956
|
+
"pathParams": [
|
|
14957
|
+
{
|
|
14958
|
+
"name": "number",
|
|
14959
|
+
"sdkName": "number"
|
|
14960
|
+
}
|
|
14961
|
+
],
|
|
14962
|
+
"query": [
|
|
14963
|
+
{
|
|
14964
|
+
"name": "repository",
|
|
14965
|
+
"type": "string",
|
|
14966
|
+
"required": false,
|
|
14967
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14968
|
+
}
|
|
14969
|
+
],
|
|
14970
|
+
"body": {
|
|
14971
|
+
"required": true,
|
|
14972
|
+
"fields": [
|
|
14973
|
+
{
|
|
14974
|
+
"name": "body",
|
|
14975
|
+
"type": "string",
|
|
14976
|
+
"required": true,
|
|
14977
|
+
"description": "Markdown text, at most 65536 characters."
|
|
14978
|
+
},
|
|
14979
|
+
{
|
|
14980
|
+
"name": "in_reply_to",
|
|
14981
|
+
"type": "string",
|
|
14982
|
+
"required": false,
|
|
14983
|
+
"description": "Opaque identifier returned by this resource's create or list operation."
|
|
14984
|
+
}
|
|
14985
|
+
]
|
|
14986
|
+
}
|
|
14987
|
+
},
|
|
14988
|
+
{
|
|
14989
|
+
"resource": "ticket.tickets.dependencies",
|
|
14990
|
+
"method": "retrieveBlockedBy",
|
|
14991
|
+
"summary": "List blocked by",
|
|
14992
|
+
"description": "List blocked by within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14993
|
+
"http": "GET",
|
|
14994
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocked_by",
|
|
14995
|
+
"streaming": "no",
|
|
14996
|
+
"pagination": false,
|
|
14997
|
+
"pathParams": [
|
|
14998
|
+
{
|
|
14999
|
+
"name": "number",
|
|
15000
|
+
"sdkName": "number"
|
|
15001
|
+
}
|
|
15002
|
+
],
|
|
15003
|
+
"query": [
|
|
15004
|
+
{
|
|
15005
|
+
"name": "repository",
|
|
15006
|
+
"type": "string",
|
|
15007
|
+
"required": false,
|
|
15008
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15009
|
+
},
|
|
15010
|
+
{
|
|
15011
|
+
"name": "page_size",
|
|
15012
|
+
"type": "integer",
|
|
15013
|
+
"required": false,
|
|
15014
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15015
|
+
},
|
|
15016
|
+
{
|
|
15017
|
+
"name": "page_token",
|
|
15018
|
+
"type": "string",
|
|
15019
|
+
"required": false,
|
|
15020
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15021
|
+
}
|
|
15022
|
+
]
|
|
15023
|
+
},
|
|
15024
|
+
{
|
|
15025
|
+
"resource": "ticket.tickets.dependencies.blockedBy",
|
|
15026
|
+
"method": "create",
|
|
15027
|
+
"summary": "Create or add blocked by",
|
|
15028
|
+
"description": "Create or add blocked by 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.",
|
|
15029
|
+
"http": "POST",
|
|
15030
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocked_by",
|
|
15031
|
+
"streaming": "no",
|
|
15032
|
+
"pagination": false,
|
|
15033
|
+
"pathParams": [
|
|
15034
|
+
{
|
|
15035
|
+
"name": "number",
|
|
15036
|
+
"sdkName": "number"
|
|
15037
|
+
}
|
|
15038
|
+
],
|
|
15039
|
+
"query": [
|
|
15040
|
+
{
|
|
15041
|
+
"name": "repository",
|
|
15042
|
+
"type": "string",
|
|
15043
|
+
"required": false,
|
|
15044
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15045
|
+
}
|
|
15046
|
+
],
|
|
15047
|
+
"body": {
|
|
15048
|
+
"required": true,
|
|
15049
|
+
"fields": [
|
|
15050
|
+
{
|
|
15051
|
+
"name": "blocked_by",
|
|
15052
|
+
"type": "integer",
|
|
15053
|
+
"required": true,
|
|
15054
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
15055
|
+
}
|
|
15056
|
+
]
|
|
15057
|
+
}
|
|
15058
|
+
},
|
|
15059
|
+
{
|
|
15060
|
+
"resource": "ticket.tickets.dependencies.blockedBy",
|
|
15061
|
+
"method": "delete",
|
|
15062
|
+
"summary": "Remove blocked by",
|
|
15063
|
+
"description": "Remove blocked by 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.",
|
|
15064
|
+
"http": "DELETE",
|
|
15065
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocked_by/{n}",
|
|
15066
|
+
"streaming": "no",
|
|
15067
|
+
"pagination": false,
|
|
15068
|
+
"pathParams": [
|
|
15069
|
+
{
|
|
15070
|
+
"name": "number",
|
|
15071
|
+
"sdkName": "number"
|
|
15072
|
+
},
|
|
15073
|
+
{
|
|
15074
|
+
"name": "n",
|
|
15075
|
+
"sdkName": "n"
|
|
15076
|
+
}
|
|
15077
|
+
],
|
|
15078
|
+
"query": [
|
|
15079
|
+
{
|
|
15080
|
+
"name": "repository",
|
|
15081
|
+
"type": "string",
|
|
15082
|
+
"required": false,
|
|
15083
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15084
|
+
}
|
|
15085
|
+
]
|
|
15086
|
+
},
|
|
15087
|
+
{
|
|
15088
|
+
"resource": "ticket.tickets.dependencies",
|
|
15089
|
+
"method": "retrieveBlocking",
|
|
15090
|
+
"summary": "List blocking",
|
|
15091
|
+
"description": "List blocking within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15092
|
+
"http": "GET",
|
|
15093
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocking",
|
|
15094
|
+
"streaming": "no",
|
|
15095
|
+
"pagination": false,
|
|
15096
|
+
"pathParams": [
|
|
15097
|
+
{
|
|
15098
|
+
"name": "number",
|
|
15099
|
+
"sdkName": "number"
|
|
15100
|
+
}
|
|
15101
|
+
],
|
|
15102
|
+
"query": [
|
|
15103
|
+
{
|
|
15104
|
+
"name": "repository",
|
|
15105
|
+
"type": "string",
|
|
15106
|
+
"required": false,
|
|
15107
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15108
|
+
},
|
|
15109
|
+
{
|
|
15110
|
+
"name": "page_size",
|
|
15111
|
+
"type": "integer",
|
|
15112
|
+
"required": false,
|
|
15113
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15114
|
+
},
|
|
15115
|
+
{
|
|
15116
|
+
"name": "page_token",
|
|
15117
|
+
"type": "string",
|
|
15118
|
+
"required": false,
|
|
15119
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15120
|
+
}
|
|
15121
|
+
]
|
|
15122
|
+
},
|
|
15123
|
+
{
|
|
15124
|
+
"resource": "ticket.tickets.events",
|
|
15125
|
+
"method": "list",
|
|
15126
|
+
"summary": "List events",
|
|
15127
|
+
"description": "List events within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15128
|
+
"http": "GET",
|
|
15129
|
+
"path": "/ticket/v1/tickets/{number}/events",
|
|
15130
|
+
"streaming": "no",
|
|
15131
|
+
"pagination": false,
|
|
15132
|
+
"pathParams": [
|
|
15133
|
+
{
|
|
15134
|
+
"name": "number",
|
|
15135
|
+
"sdkName": "number"
|
|
15136
|
+
}
|
|
15137
|
+
],
|
|
15138
|
+
"query": [
|
|
15139
|
+
{
|
|
15140
|
+
"name": "repository",
|
|
15141
|
+
"type": "string",
|
|
15142
|
+
"required": false,
|
|
15143
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15144
|
+
},
|
|
15145
|
+
{
|
|
15146
|
+
"name": "page_size",
|
|
15147
|
+
"type": "integer",
|
|
15148
|
+
"required": false,
|
|
15149
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15150
|
+
},
|
|
15151
|
+
{
|
|
15152
|
+
"name": "page_token",
|
|
15153
|
+
"type": "string",
|
|
15154
|
+
"required": false,
|
|
15155
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15156
|
+
}
|
|
15157
|
+
]
|
|
15158
|
+
},
|
|
15159
|
+
{
|
|
15160
|
+
"resource": "ticket.tickets",
|
|
15161
|
+
"method": "deleteLock",
|
|
15162
|
+
"summary": "Remove lock",
|
|
15163
|
+
"description": "Remove lock 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. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
15164
|
+
"http": "DELETE",
|
|
15165
|
+
"path": "/ticket/v1/tickets/{number}/lock",
|
|
15166
|
+
"streaming": "no",
|
|
15167
|
+
"pagination": false,
|
|
15168
|
+
"pathParams": [
|
|
15169
|
+
{
|
|
15170
|
+
"name": "number",
|
|
15171
|
+
"sdkName": "number"
|
|
15172
|
+
}
|
|
15173
|
+
],
|
|
15174
|
+
"query": [
|
|
15175
|
+
{
|
|
15176
|
+
"name": "repository",
|
|
15177
|
+
"type": "string",
|
|
15178
|
+
"required": false,
|
|
15179
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15180
|
+
}
|
|
15181
|
+
]
|
|
15182
|
+
},
|
|
15183
|
+
{
|
|
15184
|
+
"resource": "ticket.tickets",
|
|
15185
|
+
"method": "updateLock",
|
|
15186
|
+
"summary": "Update lock",
|
|
15187
|
+
"description": "Update lock 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. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
15188
|
+
"http": "PUT",
|
|
15189
|
+
"path": "/ticket/v1/tickets/{number}/lock",
|
|
15190
|
+
"streaming": "no",
|
|
15191
|
+
"pagination": false,
|
|
15192
|
+
"pathParams": [
|
|
15193
|
+
{
|
|
15194
|
+
"name": "number",
|
|
15195
|
+
"sdkName": "number"
|
|
15196
|
+
}
|
|
15197
|
+
],
|
|
15198
|
+
"query": [
|
|
15199
|
+
{
|
|
15200
|
+
"name": "repository",
|
|
15201
|
+
"type": "string",
|
|
15202
|
+
"required": false,
|
|
15203
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15204
|
+
}
|
|
15205
|
+
],
|
|
15206
|
+
"body": {
|
|
15207
|
+
"required": false,
|
|
15208
|
+
"fields": [
|
|
15209
|
+
{
|
|
15210
|
+
"name": "lock_reason",
|
|
15211
|
+
"type": "string",
|
|
15212
|
+
"enum": [
|
|
15213
|
+
"off-topic",
|
|
15214
|
+
"too heated",
|
|
15215
|
+
"resolved",
|
|
15216
|
+
"spam"
|
|
15217
|
+
],
|
|
15218
|
+
"required": false,
|
|
15219
|
+
"description": "Reason for locking: off-topic, too heated, resolved, or spam."
|
|
15220
|
+
}
|
|
15221
|
+
]
|
|
15222
|
+
}
|
|
15223
|
+
},
|
|
15224
|
+
{
|
|
15225
|
+
"resource": "ticket.tickets.reactions",
|
|
15226
|
+
"method": "list",
|
|
15227
|
+
"summary": "List reactions",
|
|
15228
|
+
"description": "List reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15229
|
+
"http": "GET",
|
|
15230
|
+
"path": "/ticket/v1/tickets/{number}/reactions",
|
|
15231
|
+
"streaming": "no",
|
|
15232
|
+
"pagination": false,
|
|
15233
|
+
"pathParams": [
|
|
15234
|
+
{
|
|
15235
|
+
"name": "number",
|
|
15236
|
+
"sdkName": "number"
|
|
15237
|
+
}
|
|
15238
|
+
],
|
|
15239
|
+
"query": [
|
|
15240
|
+
{
|
|
15241
|
+
"name": "repository",
|
|
15242
|
+
"type": "string",
|
|
15243
|
+
"required": false,
|
|
15244
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15245
|
+
},
|
|
15246
|
+
{
|
|
15247
|
+
"name": "page_size",
|
|
15248
|
+
"type": "integer",
|
|
15249
|
+
"required": false,
|
|
15250
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15251
|
+
},
|
|
15252
|
+
{
|
|
15253
|
+
"name": "page_token",
|
|
15254
|
+
"type": "string",
|
|
15255
|
+
"required": false,
|
|
15256
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15257
|
+
}
|
|
15258
|
+
]
|
|
15259
|
+
},
|
|
15260
|
+
{
|
|
15261
|
+
"resource": "ticket.tickets.reactions",
|
|
15262
|
+
"method": "create",
|
|
15263
|
+
"summary": "Create or add reactions",
|
|
15264
|
+
"description": "Create or add reactions 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.",
|
|
15265
|
+
"http": "POST",
|
|
15266
|
+
"path": "/ticket/v1/tickets/{number}/reactions",
|
|
15267
|
+
"streaming": "no",
|
|
15268
|
+
"pagination": false,
|
|
15269
|
+
"pathParams": [
|
|
15270
|
+
{
|
|
15271
|
+
"name": "number",
|
|
15272
|
+
"sdkName": "number"
|
|
15273
|
+
}
|
|
15274
|
+
],
|
|
15275
|
+
"query": [
|
|
15276
|
+
{
|
|
15277
|
+
"name": "repository",
|
|
15278
|
+
"type": "string",
|
|
15279
|
+
"required": false,
|
|
15280
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15281
|
+
}
|
|
15282
|
+
],
|
|
15283
|
+
"body": {
|
|
15284
|
+
"required": true,
|
|
15285
|
+
"fields": [
|
|
15286
|
+
{
|
|
15287
|
+
"name": "content",
|
|
15288
|
+
"type": "string",
|
|
15289
|
+
"enum": [
|
|
15290
|
+
"+1",
|
|
15291
|
+
"-1",
|
|
15292
|
+
"laugh",
|
|
15293
|
+
"confused",
|
|
15294
|
+
"heart",
|
|
15295
|
+
"hooray",
|
|
15296
|
+
"eyes",
|
|
15297
|
+
"rocket"
|
|
15298
|
+
],
|
|
15299
|
+
"required": true,
|
|
15300
|
+
"description": "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket."
|
|
15301
|
+
}
|
|
15302
|
+
]
|
|
15303
|
+
}
|
|
15304
|
+
},
|
|
15305
|
+
{
|
|
15306
|
+
"resource": "ticket.tickets.reactions",
|
|
15307
|
+
"method": "delete",
|
|
15308
|
+
"summary": "Remove reactions",
|
|
15309
|
+
"description": "Remove reactions 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.",
|
|
15310
|
+
"http": "DELETE",
|
|
15311
|
+
"path": "/ticket/v1/tickets/{number}/reactions/{content}",
|
|
15312
|
+
"streaming": "no",
|
|
15313
|
+
"pagination": false,
|
|
15314
|
+
"pathParams": [
|
|
15315
|
+
{
|
|
15316
|
+
"name": "number",
|
|
15317
|
+
"sdkName": "number"
|
|
15318
|
+
},
|
|
15319
|
+
{
|
|
15320
|
+
"name": "content",
|
|
15321
|
+
"sdkName": "content"
|
|
15322
|
+
}
|
|
15323
|
+
],
|
|
15324
|
+
"query": [
|
|
15325
|
+
{
|
|
15326
|
+
"name": "repository",
|
|
15327
|
+
"type": "string",
|
|
15328
|
+
"required": false,
|
|
15329
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15330
|
+
}
|
|
15331
|
+
]
|
|
15332
|
+
},
|
|
15333
|
+
{
|
|
15334
|
+
"resource": "ticket.tickets.relations",
|
|
15335
|
+
"method": "list",
|
|
15336
|
+
"summary": "List relations",
|
|
15337
|
+
"description": "List relations within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15338
|
+
"http": "GET",
|
|
15339
|
+
"path": "/ticket/v1/tickets/{number}/relations",
|
|
15340
|
+
"streaming": "no",
|
|
15341
|
+
"pagination": false,
|
|
15342
|
+
"pathParams": [
|
|
15343
|
+
{
|
|
15344
|
+
"name": "number",
|
|
15345
|
+
"sdkName": "number"
|
|
15346
|
+
}
|
|
15347
|
+
],
|
|
15348
|
+
"query": [
|
|
15349
|
+
{
|
|
15350
|
+
"name": "repository",
|
|
15351
|
+
"type": "string",
|
|
15352
|
+
"required": false,
|
|
15353
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15354
|
+
},
|
|
15355
|
+
{
|
|
15356
|
+
"name": "page_size",
|
|
15357
|
+
"type": "integer",
|
|
15358
|
+
"required": false,
|
|
15359
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15360
|
+
},
|
|
15361
|
+
{
|
|
15362
|
+
"name": "page_token",
|
|
15363
|
+
"type": "string",
|
|
15364
|
+
"required": false,
|
|
15365
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15366
|
+
}
|
|
15367
|
+
]
|
|
15368
|
+
},
|
|
15369
|
+
{
|
|
15370
|
+
"resource": "ticket.tickets.relations",
|
|
15371
|
+
"method": "create",
|
|
15372
|
+
"summary": "Create or add relations",
|
|
15373
|
+
"description": "Create or add relations 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.",
|
|
15374
|
+
"http": "POST",
|
|
15375
|
+
"path": "/ticket/v1/tickets/{number}/relations",
|
|
15376
|
+
"streaming": "no",
|
|
15377
|
+
"pagination": false,
|
|
15378
|
+
"pathParams": [
|
|
15379
|
+
{
|
|
15380
|
+
"name": "number",
|
|
15381
|
+
"sdkName": "number"
|
|
15382
|
+
}
|
|
15383
|
+
],
|
|
15384
|
+
"query": [
|
|
15385
|
+
{
|
|
15386
|
+
"name": "repository",
|
|
15387
|
+
"type": "string",
|
|
15388
|
+
"required": false,
|
|
15389
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15390
|
+
}
|
|
15391
|
+
],
|
|
15392
|
+
"body": {
|
|
15393
|
+
"required": true,
|
|
15394
|
+
"fields": [
|
|
15395
|
+
{
|
|
15396
|
+
"name": "relates_to",
|
|
15397
|
+
"type": "integer",
|
|
15398
|
+
"required": true,
|
|
15399
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
15400
|
+
}
|
|
15401
|
+
]
|
|
15402
|
+
}
|
|
15403
|
+
},
|
|
15404
|
+
{
|
|
15405
|
+
"resource": "ticket.tickets.relations",
|
|
15406
|
+
"method": "delete",
|
|
15407
|
+
"summary": "Remove relations",
|
|
15408
|
+
"description": "Remove relations 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.",
|
|
15409
|
+
"http": "DELETE",
|
|
15410
|
+
"path": "/ticket/v1/tickets/{number}/relations/{n}",
|
|
15411
|
+
"streaming": "no",
|
|
15412
|
+
"pagination": false,
|
|
15413
|
+
"pathParams": [
|
|
15414
|
+
{
|
|
15415
|
+
"name": "number",
|
|
15416
|
+
"sdkName": "number"
|
|
15417
|
+
},
|
|
15418
|
+
{
|
|
15419
|
+
"name": "n",
|
|
15420
|
+
"sdkName": "n"
|
|
15421
|
+
}
|
|
15422
|
+
],
|
|
15423
|
+
"query": [
|
|
15424
|
+
{
|
|
15425
|
+
"name": "repository",
|
|
15426
|
+
"type": "string",
|
|
15427
|
+
"required": false,
|
|
15428
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15429
|
+
}
|
|
15430
|
+
]
|
|
15431
|
+
},
|
|
15432
|
+
{
|
|
15433
|
+
"resource": "ticket.tickets.subTickets",
|
|
15434
|
+
"method": "list",
|
|
15435
|
+
"summary": "List sub tickets",
|
|
15436
|
+
"description": "List sub tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15437
|
+
"http": "GET",
|
|
15438
|
+
"path": "/ticket/v1/tickets/{number}/sub_tickets",
|
|
15439
|
+
"streaming": "no",
|
|
15440
|
+
"pagination": false,
|
|
15441
|
+
"pathParams": [
|
|
15442
|
+
{
|
|
15443
|
+
"name": "number",
|
|
15444
|
+
"sdkName": "number"
|
|
15445
|
+
}
|
|
15446
|
+
],
|
|
15447
|
+
"query": [
|
|
15448
|
+
{
|
|
15449
|
+
"name": "repository",
|
|
15450
|
+
"type": "string",
|
|
15451
|
+
"required": false,
|
|
15452
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15453
|
+
},
|
|
15454
|
+
{
|
|
15455
|
+
"name": "page_size",
|
|
15456
|
+
"type": "integer",
|
|
15457
|
+
"required": false,
|
|
15458
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15459
|
+
},
|
|
15460
|
+
{
|
|
15461
|
+
"name": "page_token",
|
|
15462
|
+
"type": "string",
|
|
15463
|
+
"required": false,
|
|
15464
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15465
|
+
}
|
|
15466
|
+
]
|
|
15467
|
+
},
|
|
15468
|
+
{
|
|
15469
|
+
"resource": "ticket.tickets.subTickets",
|
|
15470
|
+
"method": "create",
|
|
15471
|
+
"summary": "Create or add sub tickets",
|
|
15472
|
+
"description": "Create or add sub tickets 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.",
|
|
15473
|
+
"http": "POST",
|
|
15474
|
+
"path": "/ticket/v1/tickets/{number}/sub_tickets",
|
|
15475
|
+
"streaming": "no",
|
|
15476
|
+
"pagination": false,
|
|
15477
|
+
"pathParams": [
|
|
15478
|
+
{
|
|
15479
|
+
"name": "number",
|
|
15480
|
+
"sdkName": "number"
|
|
15481
|
+
}
|
|
15482
|
+
],
|
|
15483
|
+
"query": [
|
|
15484
|
+
{
|
|
15485
|
+
"name": "repository",
|
|
15486
|
+
"type": "string",
|
|
15487
|
+
"required": false,
|
|
15488
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15489
|
+
}
|
|
15490
|
+
],
|
|
15491
|
+
"body": {
|
|
15492
|
+
"required": true,
|
|
15493
|
+
"fields": [
|
|
15494
|
+
{
|
|
15495
|
+
"name": "child",
|
|
15496
|
+
"type": "integer",
|
|
15497
|
+
"required": true,
|
|
15498
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
15499
|
+
},
|
|
15500
|
+
{
|
|
15501
|
+
"name": "replace_parent",
|
|
15502
|
+
"type": "boolean",
|
|
15503
|
+
"required": false,
|
|
15504
|
+
"description": "Allow replacing an existing parent."
|
|
15505
|
+
}
|
|
15506
|
+
]
|
|
15507
|
+
}
|
|
15508
|
+
},
|
|
15509
|
+
{
|
|
15510
|
+
"resource": "ticket.tickets.subTickets",
|
|
15511
|
+
"method": "delete",
|
|
15512
|
+
"summary": "Remove sub tickets",
|
|
15513
|
+
"description": "Remove sub tickets 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.",
|
|
15514
|
+
"http": "DELETE",
|
|
15515
|
+
"path": "/ticket/v1/tickets/{number}/sub_tickets/{child}",
|
|
15516
|
+
"streaming": "no",
|
|
15517
|
+
"pagination": false,
|
|
15518
|
+
"pathParams": [
|
|
15519
|
+
{
|
|
15520
|
+
"name": "number",
|
|
15521
|
+
"sdkName": "number"
|
|
15522
|
+
},
|
|
15523
|
+
{
|
|
15524
|
+
"name": "child",
|
|
15525
|
+
"sdkName": "child"
|
|
15526
|
+
}
|
|
15527
|
+
],
|
|
15528
|
+
"query": [
|
|
15529
|
+
{
|
|
15530
|
+
"name": "repository",
|
|
15531
|
+
"type": "string",
|
|
15532
|
+
"required": false,
|
|
15533
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15534
|
+
}
|
|
15535
|
+
]
|
|
15536
|
+
},
|
|
15537
|
+
{
|
|
15538
|
+
"resource": "ticket.types",
|
|
15539
|
+
"method": "list",
|
|
15540
|
+
"summary": "Read types",
|
|
15541
|
+
"description": "Read types 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.",
|
|
15542
|
+
"http": "GET",
|
|
15543
|
+
"path": "/ticket/v1/types",
|
|
15544
|
+
"streaming": "no",
|
|
15545
|
+
"pagination": false,
|
|
15546
|
+
"pathParams": [],
|
|
15547
|
+
"query": [
|
|
15548
|
+
{
|
|
15549
|
+
"name": "repository",
|
|
15550
|
+
"type": "string",
|
|
15551
|
+
"required": false,
|
|
15552
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15553
|
+
}
|
|
15554
|
+
]
|
|
15555
|
+
},
|
|
13660
15556
|
{
|
|
13661
15557
|
"resource": "vault.authorizations",
|
|
13662
15558
|
"method": "create",
|