@deepraxis/sdk 0.1.0-dev.ed6ad1b → 0.1.0-dev.f8a7b74
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 +132 -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 +274 -10
- package/dist/generated/sdk.gen.js +854 -9
- package/dist/generated/types.gen.d.ts +3891 -33
- 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 +1322 -13
- package/dist/operations.generated.js +1661 -13
- package/dist/resources.generated.d.ts +249 -0
- package/dist/resources.generated.js +83 -0
- package/package.json +1 -1
|
@@ -128,6 +128,27 @@ 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": "databases",
|
|
133
|
+
"type": "array",
|
|
134
|
+
"itemType": "object",
|
|
135
|
+
"required": false,
|
|
136
|
+
"description": "Database allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings."
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
"name": "vector_stores",
|
|
140
|
+
"type": "array",
|
|
141
|
+
"itemType": "object",
|
|
142
|
+
"required": false,
|
|
143
|
+
"description": "Knowledge vector store allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings."
|
|
144
|
+
},
|
|
145
|
+
{
|
|
146
|
+
"name": "files",
|
|
147
|
+
"type": "array",
|
|
148
|
+
"itemType": "object",
|
|
149
|
+
"required": false,
|
|
150
|
+
"description": "File allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings."
|
|
151
|
+
},
|
|
131
152
|
{
|
|
132
153
|
"name": "kind",
|
|
133
154
|
"type": "string",
|
|
@@ -296,6 +317,27 @@ export const operations = [
|
|
|
296
317
|
"required": false,
|
|
297
318
|
"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
319
|
},
|
|
320
|
+
{
|
|
321
|
+
"name": "databases",
|
|
322
|
+
"type": "array",
|
|
323
|
+
"itemType": "object",
|
|
324
|
+
"required": false,
|
|
325
|
+
"description": "Replace this resource allowlist; 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 nonempty bindings."
|
|
326
|
+
},
|
|
327
|
+
{
|
|
328
|
+
"name": "vector_stores",
|
|
329
|
+
"type": "array",
|
|
330
|
+
"itemType": "object",
|
|
331
|
+
"required": false,
|
|
332
|
+
"description": "Replace this resource allowlist; 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 nonempty bindings."
|
|
333
|
+
},
|
|
334
|
+
{
|
|
335
|
+
"name": "files",
|
|
336
|
+
"type": "array",
|
|
337
|
+
"itemType": "object",
|
|
338
|
+
"required": false,
|
|
339
|
+
"description": "Replace this resource allowlist; 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 nonempty bindings."
|
|
340
|
+
},
|
|
299
341
|
{
|
|
300
342
|
"name": "kind",
|
|
301
343
|
"type": "string",
|
|
@@ -1793,7 +1835,7 @@ export const operations = [
|
|
|
1793
1835
|
"resource": "agent.sessions",
|
|
1794
1836
|
"method": "create",
|
|
1795
1837
|
"summary": "Create session",
|
|
1796
|
-
"description": "Create a session: one conversation with an agent
|
|
1838
|
+
"description": "Create a session: one conversation with an agent. Pass agent as an agent id (latest 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
1839
|
"http": "POST",
|
|
1798
1840
|
"path": "/agent/v1/sessions",
|
|
1799
1841
|
"streaming": "no",
|
|
@@ -1813,7 +1855,7 @@ export const operations = [
|
|
|
1813
1855
|
"name": "environment_id",
|
|
1814
1856
|
"type": "string",
|
|
1815
1857
|
"required": false,
|
|
1816
|
-
"description": "
|
|
1858
|
+
"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
1859
|
},
|
|
1818
1860
|
{
|
|
1819
1861
|
"name": "budget",
|
|
@@ -7587,7 +7629,7 @@ export const operations = [
|
|
|
7587
7629
|
"resource": "file.files",
|
|
7588
7630
|
"method": "create",
|
|
7589
7631
|
"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
|
|
7632
|
+
"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
7633
|
"http": "POST",
|
|
7592
7634
|
"path": "/file/v1/files",
|
|
7593
7635
|
"streaming": "no",
|
|
@@ -7602,7 +7644,7 @@ export const operations = [
|
|
|
7602
7644
|
"name": "file",
|
|
7603
7645
|
"type": "string",
|
|
7604
7646
|
"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
|
|
7647
|
+
"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
7648
|
},
|
|
7607
7649
|
{
|
|
7608
7650
|
"name": "purpose",
|
|
@@ -7651,7 +7693,7 @@ export const operations = [
|
|
|
7651
7693
|
"resource": "file.files",
|
|
7652
7694
|
"method": "retrieve",
|
|
7653
7695
|
"summary": "Retrieve file",
|
|
7654
|
-
"description": "Retrieve metadata for a live file owned by your tenant. Use its
|
|
7696
|
+
"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
7697
|
"http": "GET",
|
|
7656
7698
|
"path": "/file/v1/files/{file_id}",
|
|
7657
7699
|
"streaming": "no",
|
|
@@ -7668,7 +7710,7 @@ export const operations = [
|
|
|
7668
7710
|
"resource": "file.files",
|
|
7669
7711
|
"method": "retrieveContent",
|
|
7670
7712
|
"summary": "Retrieve file content",
|
|
7671
|
-
"description": "Download the original bytes of a live file owned by your tenant. Supply its
|
|
7713
|
+
"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
7714
|
"http": "GET",
|
|
7673
7715
|
"path": "/file/v1/files/{file_id}/content",
|
|
7674
7716
|
"streaming": "no",
|
|
@@ -7681,6 +7723,152 @@ export const operations = [
|
|
|
7681
7723
|
],
|
|
7682
7724
|
"query": []
|
|
7683
7725
|
},
|
|
7726
|
+
{
|
|
7727
|
+
"resource": "file.uploads",
|
|
7728
|
+
"method": "create",
|
|
7729
|
+
"summary": "Create an upload",
|
|
7730
|
+
"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.",
|
|
7731
|
+
"http": "POST",
|
|
7732
|
+
"path": "/file/v1/uploads",
|
|
7733
|
+
"streaming": "no",
|
|
7734
|
+
"pagination": false,
|
|
7735
|
+
"pathParams": [],
|
|
7736
|
+
"query": [],
|
|
7737
|
+
"body": {
|
|
7738
|
+
"required": true,
|
|
7739
|
+
"fields": [
|
|
7740
|
+
{
|
|
7741
|
+
"name": "bytes",
|
|
7742
|
+
"type": "integer",
|
|
7743
|
+
"required": true,
|
|
7744
|
+
"description": "Exact complete file length in bytes, from 1 through 2147483648 (2 GiB); the sum of completed parts must match."
|
|
7745
|
+
},
|
|
7746
|
+
{
|
|
7747
|
+
"name": "filename",
|
|
7748
|
+
"type": "string",
|
|
7749
|
+
"required": true,
|
|
7750
|
+
"description": "Filename for the resulting file, at most 255 UTF-8 bytes."
|
|
7751
|
+
},
|
|
7752
|
+
{
|
|
7753
|
+
"name": "mime_type",
|
|
7754
|
+
"type": "string",
|
|
7755
|
+
"required": true,
|
|
7756
|
+
"description": "Declared MIME type; validated against the assembled content."
|
|
7757
|
+
},
|
|
7758
|
+
{
|
|
7759
|
+
"name": "purpose",
|
|
7760
|
+
"type": "string",
|
|
7761
|
+
"enum": [
|
|
7762
|
+
"user_data",
|
|
7763
|
+
"assistants",
|
|
7764
|
+
"vision"
|
|
7765
|
+
],
|
|
7766
|
+
"required": true,
|
|
7767
|
+
"description": "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images."
|
|
7768
|
+
},
|
|
7769
|
+
{
|
|
7770
|
+
"name": "expires_after",
|
|
7771
|
+
"type": "object",
|
|
7772
|
+
"required": false,
|
|
7773
|
+
"description": "Optional expiry policy for the resulting file; omission retains the file until deletion."
|
|
7774
|
+
},
|
|
7775
|
+
{
|
|
7776
|
+
"name": "part_size",
|
|
7777
|
+
"type": "integer",
|
|
7778
|
+
"required": false,
|
|
7779
|
+
"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."
|
|
7780
|
+
}
|
|
7781
|
+
]
|
|
7782
|
+
}
|
|
7783
|
+
},
|
|
7784
|
+
{
|
|
7785
|
+
"resource": "file.uploads",
|
|
7786
|
+
"method": "cancel",
|
|
7787
|
+
"summary": "Cancel an upload",
|
|
7788
|
+
"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.",
|
|
7789
|
+
"http": "POST",
|
|
7790
|
+
"path": "/file/v1/uploads/{upload_id}/cancel",
|
|
7791
|
+
"streaming": "no",
|
|
7792
|
+
"pagination": false,
|
|
7793
|
+
"pathParams": [
|
|
7794
|
+
{
|
|
7795
|
+
"name": "upload_id",
|
|
7796
|
+
"sdkName": "upload_id"
|
|
7797
|
+
}
|
|
7798
|
+
],
|
|
7799
|
+
"query": []
|
|
7800
|
+
},
|
|
7801
|
+
{
|
|
7802
|
+
"resource": "file.uploads",
|
|
7803
|
+
"method": "complete",
|
|
7804
|
+
"summary": "Complete an upload",
|
|
7805
|
+
"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.",
|
|
7806
|
+
"http": "POST",
|
|
7807
|
+
"path": "/file/v1/uploads/{upload_id}/complete",
|
|
7808
|
+
"streaming": "no",
|
|
7809
|
+
"pagination": false,
|
|
7810
|
+
"pathParams": [
|
|
7811
|
+
{
|
|
7812
|
+
"name": "upload_id",
|
|
7813
|
+
"sdkName": "upload_id"
|
|
7814
|
+
}
|
|
7815
|
+
],
|
|
7816
|
+
"query": [],
|
|
7817
|
+
"body": {
|
|
7818
|
+
"required": true,
|
|
7819
|
+
"fields": [
|
|
7820
|
+
{
|
|
7821
|
+
"name": "part_ids",
|
|
7822
|
+
"type": "array",
|
|
7823
|
+
"itemType": "string",
|
|
7824
|
+
"required": true,
|
|
7825
|
+
"description": "All part IDs in concatenation order, without duplicates. Fixed-size uploads require increasing part_number order."
|
|
7826
|
+
},
|
|
7827
|
+
{
|
|
7828
|
+
"name": "md5",
|
|
7829
|
+
"type": "string",
|
|
7830
|
+
"required": false,
|
|
7831
|
+
"description": "Optional whole-file MD5 as 32 hexadecimal characters; verified after assembly."
|
|
7832
|
+
}
|
|
7833
|
+
]
|
|
7834
|
+
}
|
|
7835
|
+
},
|
|
7836
|
+
{
|
|
7837
|
+
"resource": "file.uploads.parts",
|
|
7838
|
+
"method": "create",
|
|
7839
|
+
"summary": "Add an upload part",
|
|
7840
|
+
"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.",
|
|
7841
|
+
"http": "POST",
|
|
7842
|
+
"path": "/file/v1/uploads/{upload_id}/parts",
|
|
7843
|
+
"streaming": "no",
|
|
7844
|
+
"pagination": false,
|
|
7845
|
+
"multipart": true,
|
|
7846
|
+
"pathParams": [
|
|
7847
|
+
{
|
|
7848
|
+
"name": "upload_id",
|
|
7849
|
+
"sdkName": "upload_id"
|
|
7850
|
+
}
|
|
7851
|
+
],
|
|
7852
|
+
"query": [
|
|
7853
|
+
{
|
|
7854
|
+
"name": "part_number",
|
|
7855
|
+
"type": "integer",
|
|
7856
|
+
"required": false,
|
|
7857
|
+
"description": "Required when create set part_size; 1 through ceil(bytes / part_size). Ignored for general uploads."
|
|
7858
|
+
}
|
|
7859
|
+
],
|
|
7860
|
+
"body": {
|
|
7861
|
+
"required": true,
|
|
7862
|
+
"fields": [
|
|
7863
|
+
{
|
|
7864
|
+
"name": "data",
|
|
7865
|
+
"type": "string",
|
|
7866
|
+
"required": true,
|
|
7867
|
+
"description": "Raw bytes of this part, nonempty and at most 64000000 bytes."
|
|
7868
|
+
}
|
|
7869
|
+
]
|
|
7870
|
+
}
|
|
7871
|
+
},
|
|
7684
7872
|
{
|
|
7685
7873
|
"resource": "knowledge.vectorStores",
|
|
7686
7874
|
"method": "list",
|
|
@@ -11811,7 +11999,7 @@ export const operations = [
|
|
|
11811
11999
|
"name": "message",
|
|
11812
12000
|
"type": "string",
|
|
11813
12001
|
"required": true,
|
|
11814
|
-
"description": "Problem description
|
|
12002
|
+
"description": "Problem description, at most 4096 Unicode code points; may be empty only when contexts.praxis.error.message is a non-empty string."
|
|
11815
12003
|
},
|
|
11816
12004
|
{
|
|
11817
12005
|
"name": "contact_email",
|
|
@@ -12109,7 +12297,7 @@ export const operations = [
|
|
|
12109
12297
|
"resource": "sandbox.sandboxes",
|
|
12110
12298
|
"method": "create",
|
|
12111
12299
|
"summary": "Create sandbox (v2)",
|
|
12112
|
-
"description": "
|
|
12300
|
+
"description": "Create a sandbox from the template. All system communication with the sandbox is secured.",
|
|
12113
12301
|
"http": "POST",
|
|
12114
12302
|
"path": "/sandbox/v1/sandboxes",
|
|
12115
12303
|
"streaming": "no",
|
|
@@ -12123,7 +12311,7 @@ export const operations = [
|
|
|
12123
12311
|
"name": "templateID",
|
|
12124
12312
|
"type": "string",
|
|
12125
12313
|
"required": true,
|
|
12126
|
-
"description": "
|
|
12314
|
+
"description": "Identifier of the required template"
|
|
12127
12315
|
},
|
|
12128
12316
|
{
|
|
12129
12317
|
"name": "timeout",
|
|
@@ -12261,7 +12449,7 @@ export const operations = [
|
|
|
12261
12449
|
"resource": "sandbox.sandboxes",
|
|
12262
12450
|
"method": "connect",
|
|
12263
12451
|
"summary": "Connect sandbox (v2)",
|
|
12264
|
-
"description": "
|
|
12452
|
+
"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
12453
|
"http": "POST",
|
|
12266
12454
|
"path": "/sandbox/v1/sandboxes/{sandboxID}/connect",
|
|
12267
12455
|
"streaming": "no",
|
|
@@ -12420,7 +12608,7 @@ export const operations = [
|
|
|
12420
12608
|
"resource": "sandbox.sandboxes.metrics",
|
|
12421
12609
|
"method": "list",
|
|
12422
12610
|
"summary": "Sandbox metrics",
|
|
12423
|
-
"description": "Read CPU, memory and disk usage over
|
|
12611
|
+
"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
12612
|
"http": "GET",
|
|
12425
12613
|
"path": "/sandbox/v1/sandboxes/{sandboxID}/metrics",
|
|
12426
12614
|
"streaming": "no",
|
|
@@ -12504,7 +12692,7 @@ export const operations = [
|
|
|
12504
12692
|
"resource": "sandbox.sandboxes",
|
|
12505
12693
|
"method": "pause",
|
|
12506
12694
|
"summary": "Pause sandbox",
|
|
12507
|
-
"description": "
|
|
12695
|
+
"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
12696
|
"http": "POST",
|
|
12509
12697
|
"path": "/sandbox/v1/sandboxes/{sandboxID}/pause",
|
|
12510
12698
|
"streaming": "no",
|
|
@@ -12896,7 +13084,7 @@ export const operations = [
|
|
|
12896
13084
|
"resource": "sandbox.templates",
|
|
12897
13085
|
"method": "list",
|
|
12898
13086
|
"summary": "List templates (v2)",
|
|
12899
|
-
"description": "
|
|
13087
|
+
"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
13088
|
"http": "GET",
|
|
12901
13089
|
"path": "/sandbox/v1/templates",
|
|
12902
13090
|
"streaming": "no",
|
|
@@ -13657,6 +13845,1466 @@ export const operations = [
|
|
|
13657
13845
|
]
|
|
13658
13846
|
}
|
|
13659
13847
|
},
|
|
13848
|
+
{
|
|
13849
|
+
"resource": "ticket.activity",
|
|
13850
|
+
"method": "retrieve",
|
|
13851
|
+
"summary": "List activity",
|
|
13852
|
+
"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.",
|
|
13853
|
+
"http": "GET",
|
|
13854
|
+
"path": "/ticket/v1/activity",
|
|
13855
|
+
"streaming": "no",
|
|
13856
|
+
"pagination": false,
|
|
13857
|
+
"pathParams": [],
|
|
13858
|
+
"query": [
|
|
13859
|
+
{
|
|
13860
|
+
"name": "repository",
|
|
13861
|
+
"type": "string",
|
|
13862
|
+
"required": false,
|
|
13863
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
13864
|
+
},
|
|
13865
|
+
{
|
|
13866
|
+
"name": "page_size",
|
|
13867
|
+
"type": "integer",
|
|
13868
|
+
"required": false,
|
|
13869
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
13870
|
+
},
|
|
13871
|
+
{
|
|
13872
|
+
"name": "page_token",
|
|
13873
|
+
"type": "string",
|
|
13874
|
+
"required": false,
|
|
13875
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
13876
|
+
},
|
|
13877
|
+
{
|
|
13878
|
+
"name": "filter",
|
|
13879
|
+
"type": "string",
|
|
13880
|
+
"required": false,
|
|
13881
|
+
"description": "Activity qualifiers: actor, actor-kind, action, ticket, source and since; passed unchanged to the service."
|
|
13882
|
+
}
|
|
13883
|
+
]
|
|
13884
|
+
},
|
|
13885
|
+
{
|
|
13886
|
+
"resource": "ticket.comments",
|
|
13887
|
+
"method": "delete",
|
|
13888
|
+
"summary": "Remove comments",
|
|
13889
|
+
"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.",
|
|
13890
|
+
"http": "DELETE",
|
|
13891
|
+
"path": "/ticket/v1/comments/{id}",
|
|
13892
|
+
"streaming": "no",
|
|
13893
|
+
"pagination": false,
|
|
13894
|
+
"pathParams": [
|
|
13895
|
+
{
|
|
13896
|
+
"name": "id",
|
|
13897
|
+
"sdkName": "id"
|
|
13898
|
+
}
|
|
13899
|
+
],
|
|
13900
|
+
"query": [
|
|
13901
|
+
{
|
|
13902
|
+
"name": "repository",
|
|
13903
|
+
"type": "string",
|
|
13904
|
+
"required": false,
|
|
13905
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
13906
|
+
}
|
|
13907
|
+
]
|
|
13908
|
+
},
|
|
13909
|
+
{
|
|
13910
|
+
"resource": "ticket.comments",
|
|
13911
|
+
"method": "retrieve",
|
|
13912
|
+
"summary": "Read comments",
|
|
13913
|
+
"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.",
|
|
13914
|
+
"http": "GET",
|
|
13915
|
+
"path": "/ticket/v1/comments/{id}",
|
|
13916
|
+
"streaming": "no",
|
|
13917
|
+
"pagination": false,
|
|
13918
|
+
"pathParams": [
|
|
13919
|
+
{
|
|
13920
|
+
"name": "id",
|
|
13921
|
+
"sdkName": "id"
|
|
13922
|
+
}
|
|
13923
|
+
],
|
|
13924
|
+
"query": [
|
|
13925
|
+
{
|
|
13926
|
+
"name": "repository",
|
|
13927
|
+
"type": "string",
|
|
13928
|
+
"required": false,
|
|
13929
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
13930
|
+
}
|
|
13931
|
+
]
|
|
13932
|
+
},
|
|
13933
|
+
{
|
|
13934
|
+
"resource": "ticket.comments",
|
|
13935
|
+
"method": "update",
|
|
13936
|
+
"summary": "Update comments",
|
|
13937
|
+
"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.",
|
|
13938
|
+
"http": "PATCH",
|
|
13939
|
+
"path": "/ticket/v1/comments/{id}",
|
|
13940
|
+
"streaming": "no",
|
|
13941
|
+
"pagination": false,
|
|
13942
|
+
"pathParams": [
|
|
13943
|
+
{
|
|
13944
|
+
"name": "id",
|
|
13945
|
+
"sdkName": "id"
|
|
13946
|
+
}
|
|
13947
|
+
],
|
|
13948
|
+
"query": [
|
|
13949
|
+
{
|
|
13950
|
+
"name": "repository",
|
|
13951
|
+
"type": "string",
|
|
13952
|
+
"required": false,
|
|
13953
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
13954
|
+
}
|
|
13955
|
+
],
|
|
13956
|
+
"body": {
|
|
13957
|
+
"required": true,
|
|
13958
|
+
"fields": [
|
|
13959
|
+
{
|
|
13960
|
+
"name": "body",
|
|
13961
|
+
"type": "string",
|
|
13962
|
+
"required": true,
|
|
13963
|
+
"description": "Markdown text, at most 65536 characters."
|
|
13964
|
+
},
|
|
13965
|
+
{
|
|
13966
|
+
"name": "in_reply_to",
|
|
13967
|
+
"type": "string",
|
|
13968
|
+
"required": false,
|
|
13969
|
+
"description": "Opaque identifier returned by this resource's create or list operation."
|
|
13970
|
+
}
|
|
13971
|
+
]
|
|
13972
|
+
}
|
|
13973
|
+
},
|
|
13974
|
+
{
|
|
13975
|
+
"resource": "ticket.comments.reactions",
|
|
13976
|
+
"method": "list",
|
|
13977
|
+
"summary": "List reactions",
|
|
13978
|
+
"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.",
|
|
13979
|
+
"http": "GET",
|
|
13980
|
+
"path": "/ticket/v1/comments/{id}/reactions",
|
|
13981
|
+
"streaming": "no",
|
|
13982
|
+
"pagination": false,
|
|
13983
|
+
"pathParams": [
|
|
13984
|
+
{
|
|
13985
|
+
"name": "id",
|
|
13986
|
+
"sdkName": "id"
|
|
13987
|
+
}
|
|
13988
|
+
],
|
|
13989
|
+
"query": [
|
|
13990
|
+
{
|
|
13991
|
+
"name": "repository",
|
|
13992
|
+
"type": "string",
|
|
13993
|
+
"required": false,
|
|
13994
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
13995
|
+
},
|
|
13996
|
+
{
|
|
13997
|
+
"name": "page_size",
|
|
13998
|
+
"type": "integer",
|
|
13999
|
+
"required": false,
|
|
14000
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14001
|
+
},
|
|
14002
|
+
{
|
|
14003
|
+
"name": "page_token",
|
|
14004
|
+
"type": "string",
|
|
14005
|
+
"required": false,
|
|
14006
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14007
|
+
}
|
|
14008
|
+
]
|
|
14009
|
+
},
|
|
14010
|
+
{
|
|
14011
|
+
"resource": "ticket.comments.reactions",
|
|
14012
|
+
"method": "create",
|
|
14013
|
+
"summary": "Create or add reactions",
|
|
14014
|
+
"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.",
|
|
14015
|
+
"http": "POST",
|
|
14016
|
+
"path": "/ticket/v1/comments/{id}/reactions",
|
|
14017
|
+
"streaming": "no",
|
|
14018
|
+
"pagination": false,
|
|
14019
|
+
"pathParams": [
|
|
14020
|
+
{
|
|
14021
|
+
"name": "id",
|
|
14022
|
+
"sdkName": "id"
|
|
14023
|
+
}
|
|
14024
|
+
],
|
|
14025
|
+
"query": [
|
|
14026
|
+
{
|
|
14027
|
+
"name": "repository",
|
|
14028
|
+
"type": "string",
|
|
14029
|
+
"required": false,
|
|
14030
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14031
|
+
}
|
|
14032
|
+
],
|
|
14033
|
+
"body": {
|
|
14034
|
+
"required": true,
|
|
14035
|
+
"fields": [
|
|
14036
|
+
{
|
|
14037
|
+
"name": "content",
|
|
14038
|
+
"type": "string",
|
|
14039
|
+
"enum": [
|
|
14040
|
+
"+1",
|
|
14041
|
+
"-1",
|
|
14042
|
+
"laugh",
|
|
14043
|
+
"confused",
|
|
14044
|
+
"heart",
|
|
14045
|
+
"hooray",
|
|
14046
|
+
"eyes",
|
|
14047
|
+
"rocket"
|
|
14048
|
+
],
|
|
14049
|
+
"required": true,
|
|
14050
|
+
"description": "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket."
|
|
14051
|
+
}
|
|
14052
|
+
]
|
|
14053
|
+
}
|
|
14054
|
+
},
|
|
14055
|
+
{
|
|
14056
|
+
"resource": "ticket.comments.reactions",
|
|
14057
|
+
"method": "delete",
|
|
14058
|
+
"summary": "Remove reactions",
|
|
14059
|
+
"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.",
|
|
14060
|
+
"http": "DELETE",
|
|
14061
|
+
"path": "/ticket/v1/comments/{id}/reactions/{content}",
|
|
14062
|
+
"streaming": "no",
|
|
14063
|
+
"pagination": false,
|
|
14064
|
+
"pathParams": [
|
|
14065
|
+
{
|
|
14066
|
+
"name": "id",
|
|
14067
|
+
"sdkName": "id"
|
|
14068
|
+
},
|
|
14069
|
+
{
|
|
14070
|
+
"name": "content",
|
|
14071
|
+
"sdkName": "content"
|
|
14072
|
+
}
|
|
14073
|
+
],
|
|
14074
|
+
"query": [
|
|
14075
|
+
{
|
|
14076
|
+
"name": "repository",
|
|
14077
|
+
"type": "string",
|
|
14078
|
+
"required": false,
|
|
14079
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14080
|
+
}
|
|
14081
|
+
]
|
|
14082
|
+
},
|
|
14083
|
+
{
|
|
14084
|
+
"resource": "ticket.labels",
|
|
14085
|
+
"method": "list",
|
|
14086
|
+
"summary": "List labels",
|
|
14087
|
+
"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.",
|
|
14088
|
+
"http": "GET",
|
|
14089
|
+
"path": "/ticket/v1/labels",
|
|
14090
|
+
"streaming": "no",
|
|
14091
|
+
"pagination": false,
|
|
14092
|
+
"pathParams": [],
|
|
14093
|
+
"query": [
|
|
14094
|
+
{
|
|
14095
|
+
"name": "repository",
|
|
14096
|
+
"type": "string",
|
|
14097
|
+
"required": false,
|
|
14098
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14099
|
+
},
|
|
14100
|
+
{
|
|
14101
|
+
"name": "page_size",
|
|
14102
|
+
"type": "integer",
|
|
14103
|
+
"required": false,
|
|
14104
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14105
|
+
},
|
|
14106
|
+
{
|
|
14107
|
+
"name": "page_token",
|
|
14108
|
+
"type": "string",
|
|
14109
|
+
"required": false,
|
|
14110
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14111
|
+
}
|
|
14112
|
+
]
|
|
14113
|
+
},
|
|
14114
|
+
{
|
|
14115
|
+
"resource": "ticket.labels",
|
|
14116
|
+
"method": "create",
|
|
14117
|
+
"summary": "Create or add labels",
|
|
14118
|
+
"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.",
|
|
14119
|
+
"http": "POST",
|
|
14120
|
+
"path": "/ticket/v1/labels",
|
|
14121
|
+
"streaming": "no",
|
|
14122
|
+
"pagination": false,
|
|
14123
|
+
"pathParams": [],
|
|
14124
|
+
"query": [
|
|
14125
|
+
{
|
|
14126
|
+
"name": "repository",
|
|
14127
|
+
"type": "string",
|
|
14128
|
+
"required": false,
|
|
14129
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14130
|
+
}
|
|
14131
|
+
],
|
|
14132
|
+
"body": {
|
|
14133
|
+
"required": true,
|
|
14134
|
+
"fields": [
|
|
14135
|
+
{
|
|
14136
|
+
"name": "name",
|
|
14137
|
+
"type": "string",
|
|
14138
|
+
"required": true,
|
|
14139
|
+
"description": "Case-insensitive label name within the repository."
|
|
14140
|
+
},
|
|
14141
|
+
{
|
|
14142
|
+
"name": "color",
|
|
14143
|
+
"type": "string",
|
|
14144
|
+
"required": true,
|
|
14145
|
+
"description": "Six hexadecimal digits without #."
|
|
14146
|
+
},
|
|
14147
|
+
{
|
|
14148
|
+
"name": "description",
|
|
14149
|
+
"type": "string",
|
|
14150
|
+
"required": false,
|
|
14151
|
+
"description": "Label's purpose."
|
|
14152
|
+
}
|
|
14153
|
+
]
|
|
14154
|
+
}
|
|
14155
|
+
},
|
|
14156
|
+
{
|
|
14157
|
+
"resource": "ticket.labels",
|
|
14158
|
+
"method": "delete",
|
|
14159
|
+
"summary": "Remove labels",
|
|
14160
|
+
"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.",
|
|
14161
|
+
"http": "DELETE",
|
|
14162
|
+
"path": "/ticket/v1/labels/{name}",
|
|
14163
|
+
"streaming": "no",
|
|
14164
|
+
"pagination": false,
|
|
14165
|
+
"pathParams": [
|
|
14166
|
+
{
|
|
14167
|
+
"name": "name",
|
|
14168
|
+
"sdkName": "name"
|
|
14169
|
+
}
|
|
14170
|
+
],
|
|
14171
|
+
"query": [
|
|
14172
|
+
{
|
|
14173
|
+
"name": "repository",
|
|
14174
|
+
"type": "string",
|
|
14175
|
+
"required": false,
|
|
14176
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14177
|
+
}
|
|
14178
|
+
]
|
|
14179
|
+
},
|
|
14180
|
+
{
|
|
14181
|
+
"resource": "ticket.labels",
|
|
14182
|
+
"method": "update",
|
|
14183
|
+
"summary": "Update labels",
|
|
14184
|
+
"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.",
|
|
14185
|
+
"http": "PATCH",
|
|
14186
|
+
"path": "/ticket/v1/labels/{name}",
|
|
14187
|
+
"streaming": "no",
|
|
14188
|
+
"pagination": false,
|
|
14189
|
+
"pathParams": [
|
|
14190
|
+
{
|
|
14191
|
+
"name": "name",
|
|
14192
|
+
"sdkName": "name"
|
|
14193
|
+
}
|
|
14194
|
+
],
|
|
14195
|
+
"query": [
|
|
14196
|
+
{
|
|
14197
|
+
"name": "repository",
|
|
14198
|
+
"type": "string",
|
|
14199
|
+
"required": false,
|
|
14200
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14201
|
+
}
|
|
14202
|
+
],
|
|
14203
|
+
"body": {
|
|
14204
|
+
"required": true,
|
|
14205
|
+
"fields": [
|
|
14206
|
+
{
|
|
14207
|
+
"name": "color",
|
|
14208
|
+
"type": "string",
|
|
14209
|
+
"required": false,
|
|
14210
|
+
"description": "Six hexadecimal digits without #."
|
|
14211
|
+
},
|
|
14212
|
+
{
|
|
14213
|
+
"name": "description",
|
|
14214
|
+
"type": "string",
|
|
14215
|
+
"required": false,
|
|
14216
|
+
"description": "Label's purpose."
|
|
14217
|
+
},
|
|
14218
|
+
{
|
|
14219
|
+
"name": "new_name",
|
|
14220
|
+
"type": "string",
|
|
14221
|
+
"required": false,
|
|
14222
|
+
"description": "Case-insensitive label name within the repository."
|
|
14223
|
+
}
|
|
14224
|
+
]
|
|
14225
|
+
}
|
|
14226
|
+
},
|
|
14227
|
+
{
|
|
14228
|
+
"resource": "ticket.milestones",
|
|
14229
|
+
"method": "list",
|
|
14230
|
+
"summary": "List milestones",
|
|
14231
|
+
"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.",
|
|
14232
|
+
"http": "GET",
|
|
14233
|
+
"path": "/ticket/v1/milestones",
|
|
14234
|
+
"streaming": "no",
|
|
14235
|
+
"pagination": false,
|
|
14236
|
+
"pathParams": [],
|
|
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.milestones",
|
|
14260
|
+
"method": "create",
|
|
14261
|
+
"summary": "Create or add milestones",
|
|
14262
|
+
"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.",
|
|
14263
|
+
"http": "POST",
|
|
14264
|
+
"path": "/ticket/v1/milestones",
|
|
14265
|
+
"streaming": "no",
|
|
14266
|
+
"pagination": false,
|
|
14267
|
+
"pathParams": [],
|
|
14268
|
+
"query": [
|
|
14269
|
+
{
|
|
14270
|
+
"name": "repository",
|
|
14271
|
+
"type": "string",
|
|
14272
|
+
"required": false,
|
|
14273
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14274
|
+
}
|
|
14275
|
+
],
|
|
14276
|
+
"body": {
|
|
14277
|
+
"required": true,
|
|
14278
|
+
"fields": [
|
|
14279
|
+
{
|
|
14280
|
+
"name": "title",
|
|
14281
|
+
"type": "string",
|
|
14282
|
+
"required": true,
|
|
14283
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
14284
|
+
},
|
|
14285
|
+
{
|
|
14286
|
+
"name": "description",
|
|
14287
|
+
"type": "string",
|
|
14288
|
+
"required": false,
|
|
14289
|
+
"description": "Milestone description."
|
|
14290
|
+
},
|
|
14291
|
+
{
|
|
14292
|
+
"name": "due_on",
|
|
14293
|
+
"type": "string",
|
|
14294
|
+
"required": false,
|
|
14295
|
+
"description": "Due date, or null if unset."
|
|
14296
|
+
},
|
|
14297
|
+
{
|
|
14298
|
+
"name": "state",
|
|
14299
|
+
"type": "string",
|
|
14300
|
+
"enum": [
|
|
14301
|
+
"open",
|
|
14302
|
+
"closed"
|
|
14303
|
+
],
|
|
14304
|
+
"required": false,
|
|
14305
|
+
"description": "open means actionable; closed means resolved or declined."
|
|
14306
|
+
}
|
|
14307
|
+
]
|
|
14308
|
+
}
|
|
14309
|
+
},
|
|
14310
|
+
{
|
|
14311
|
+
"resource": "ticket.milestones",
|
|
14312
|
+
"method": "delete",
|
|
14313
|
+
"summary": "Remove milestones",
|
|
14314
|
+
"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.",
|
|
14315
|
+
"http": "DELETE",
|
|
14316
|
+
"path": "/ticket/v1/milestones/{number}",
|
|
14317
|
+
"streaming": "no",
|
|
14318
|
+
"pagination": false,
|
|
14319
|
+
"pathParams": [
|
|
14320
|
+
{
|
|
14321
|
+
"name": "number",
|
|
14322
|
+
"sdkName": "number"
|
|
14323
|
+
}
|
|
14324
|
+
],
|
|
14325
|
+
"query": [
|
|
14326
|
+
{
|
|
14327
|
+
"name": "repository",
|
|
14328
|
+
"type": "string",
|
|
14329
|
+
"required": false,
|
|
14330
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14331
|
+
}
|
|
14332
|
+
]
|
|
14333
|
+
},
|
|
14334
|
+
{
|
|
14335
|
+
"resource": "ticket.milestones",
|
|
14336
|
+
"method": "retrieve",
|
|
14337
|
+
"summary": "Read milestones",
|
|
14338
|
+
"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.",
|
|
14339
|
+
"http": "GET",
|
|
14340
|
+
"path": "/ticket/v1/milestones/{number}",
|
|
14341
|
+
"streaming": "no",
|
|
14342
|
+
"pagination": false,
|
|
14343
|
+
"pathParams": [
|
|
14344
|
+
{
|
|
14345
|
+
"name": "number",
|
|
14346
|
+
"sdkName": "number"
|
|
14347
|
+
}
|
|
14348
|
+
],
|
|
14349
|
+
"query": [
|
|
14350
|
+
{
|
|
14351
|
+
"name": "repository",
|
|
14352
|
+
"type": "string",
|
|
14353
|
+
"required": false,
|
|
14354
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14355
|
+
}
|
|
14356
|
+
]
|
|
14357
|
+
},
|
|
14358
|
+
{
|
|
14359
|
+
"resource": "ticket.milestones",
|
|
14360
|
+
"method": "update",
|
|
14361
|
+
"summary": "Update milestones",
|
|
14362
|
+
"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.",
|
|
14363
|
+
"http": "PATCH",
|
|
14364
|
+
"path": "/ticket/v1/milestones/{number}",
|
|
14365
|
+
"streaming": "no",
|
|
14366
|
+
"pagination": false,
|
|
14367
|
+
"pathParams": [
|
|
14368
|
+
{
|
|
14369
|
+
"name": "number",
|
|
14370
|
+
"sdkName": "number"
|
|
14371
|
+
}
|
|
14372
|
+
],
|
|
14373
|
+
"query": [
|
|
14374
|
+
{
|
|
14375
|
+
"name": "repository",
|
|
14376
|
+
"type": "string",
|
|
14377
|
+
"required": false,
|
|
14378
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14379
|
+
}
|
|
14380
|
+
],
|
|
14381
|
+
"body": {
|
|
14382
|
+
"required": true,
|
|
14383
|
+
"fields": [
|
|
14384
|
+
{
|
|
14385
|
+
"name": "title",
|
|
14386
|
+
"type": "string",
|
|
14387
|
+
"required": false,
|
|
14388
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
14389
|
+
},
|
|
14390
|
+
{
|
|
14391
|
+
"name": "description",
|
|
14392
|
+
"type": "string",
|
|
14393
|
+
"required": false,
|
|
14394
|
+
"description": "Milestone description."
|
|
14395
|
+
},
|
|
14396
|
+
{
|
|
14397
|
+
"name": "due_on",
|
|
14398
|
+
"type": "string",
|
|
14399
|
+
"required": false,
|
|
14400
|
+
"description": "Due date, or null if unset."
|
|
14401
|
+
},
|
|
14402
|
+
{
|
|
14403
|
+
"name": "state",
|
|
14404
|
+
"type": "string",
|
|
14405
|
+
"enum": [
|
|
14406
|
+
"open",
|
|
14407
|
+
"closed"
|
|
14408
|
+
],
|
|
14409
|
+
"required": false,
|
|
14410
|
+
"description": "open means actionable; closed means resolved or declined."
|
|
14411
|
+
}
|
|
14412
|
+
]
|
|
14413
|
+
}
|
|
14414
|
+
},
|
|
14415
|
+
{
|
|
14416
|
+
"resource": "ticket.repositories",
|
|
14417
|
+
"method": "list",
|
|
14418
|
+
"summary": "List repositories",
|
|
14419
|
+
"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.",
|
|
14420
|
+
"http": "GET",
|
|
14421
|
+
"path": "/ticket/v1/repositories",
|
|
14422
|
+
"streaming": "no",
|
|
14423
|
+
"pagination": false,
|
|
14424
|
+
"pathParams": [],
|
|
14425
|
+
"query": [
|
|
14426
|
+
{
|
|
14427
|
+
"name": "page_size",
|
|
14428
|
+
"type": "integer",
|
|
14429
|
+
"required": false,
|
|
14430
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14431
|
+
},
|
|
14432
|
+
{
|
|
14433
|
+
"name": "page_token",
|
|
14434
|
+
"type": "string",
|
|
14435
|
+
"required": false,
|
|
14436
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14437
|
+
}
|
|
14438
|
+
]
|
|
14439
|
+
},
|
|
14440
|
+
{
|
|
14441
|
+
"resource": "ticket.tickets",
|
|
14442
|
+
"method": "list",
|
|
14443
|
+
"summary": "List tickets",
|
|
14444
|
+
"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.",
|
|
14445
|
+
"http": "GET",
|
|
14446
|
+
"path": "/ticket/v1/tickets",
|
|
14447
|
+
"streaming": "no",
|
|
14448
|
+
"pagination": false,
|
|
14449
|
+
"pathParams": [],
|
|
14450
|
+
"query": [
|
|
14451
|
+
{
|
|
14452
|
+
"name": "repository",
|
|
14453
|
+
"type": "string",
|
|
14454
|
+
"required": false,
|
|
14455
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14456
|
+
},
|
|
14457
|
+
{
|
|
14458
|
+
"name": "page_size",
|
|
14459
|
+
"type": "integer",
|
|
14460
|
+
"required": false,
|
|
14461
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14462
|
+
},
|
|
14463
|
+
{
|
|
14464
|
+
"name": "page_token",
|
|
14465
|
+
"type": "string",
|
|
14466
|
+
"required": false,
|
|
14467
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14468
|
+
},
|
|
14469
|
+
{
|
|
14470
|
+
"name": "filter",
|
|
14471
|
+
"type": "string",
|
|
14472
|
+
"required": false,
|
|
14473
|
+
"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."
|
|
14474
|
+
}
|
|
14475
|
+
]
|
|
14476
|
+
},
|
|
14477
|
+
{
|
|
14478
|
+
"resource": "ticket.tickets",
|
|
14479
|
+
"method": "create",
|
|
14480
|
+
"summary": "Create or add tickets",
|
|
14481
|
+
"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.",
|
|
14482
|
+
"http": "POST",
|
|
14483
|
+
"path": "/ticket/v1/tickets",
|
|
14484
|
+
"streaming": "no",
|
|
14485
|
+
"pagination": false,
|
|
14486
|
+
"pathParams": [],
|
|
14487
|
+
"query": [
|
|
14488
|
+
{
|
|
14489
|
+
"name": "repository",
|
|
14490
|
+
"type": "string",
|
|
14491
|
+
"required": false,
|
|
14492
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14493
|
+
}
|
|
14494
|
+
],
|
|
14495
|
+
"body": {
|
|
14496
|
+
"required": true,
|
|
14497
|
+
"fields": [
|
|
14498
|
+
{
|
|
14499
|
+
"name": "title",
|
|
14500
|
+
"type": "string",
|
|
14501
|
+
"required": true,
|
|
14502
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
14503
|
+
},
|
|
14504
|
+
{
|
|
14505
|
+
"name": "body",
|
|
14506
|
+
"type": "string",
|
|
14507
|
+
"required": false,
|
|
14508
|
+
"description": "Markdown text, at most 65536 characters."
|
|
14509
|
+
},
|
|
14510
|
+
{
|
|
14511
|
+
"name": "type",
|
|
14512
|
+
"type": "string",
|
|
14513
|
+
"required": false,
|
|
14514
|
+
"description": "Built-in type name; null clears an existing type."
|
|
14515
|
+
},
|
|
14516
|
+
{
|
|
14517
|
+
"name": "labels",
|
|
14518
|
+
"type": "array",
|
|
14519
|
+
"itemType": "string",
|
|
14520
|
+
"required": false,
|
|
14521
|
+
"description": "Labels attached to this ticket; updates replace the complete list."
|
|
14522
|
+
},
|
|
14523
|
+
{
|
|
14524
|
+
"name": "assignees",
|
|
14525
|
+
"type": "array",
|
|
14526
|
+
"itemType": "string",
|
|
14527
|
+
"required": false,
|
|
14528
|
+
"description": "Complete assignee list, at most ten."
|
|
14529
|
+
},
|
|
14530
|
+
{
|
|
14531
|
+
"name": "milestone",
|
|
14532
|
+
"type": "integer",
|
|
14533
|
+
"required": false,
|
|
14534
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
14535
|
+
},
|
|
14536
|
+
{
|
|
14537
|
+
"name": "parent",
|
|
14538
|
+
"type": "integer",
|
|
14539
|
+
"required": false,
|
|
14540
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
14541
|
+
}
|
|
14542
|
+
]
|
|
14543
|
+
}
|
|
14544
|
+
},
|
|
14545
|
+
{
|
|
14546
|
+
"resource": "ticket.tickets",
|
|
14547
|
+
"method": "retrieve",
|
|
14548
|
+
"summary": "Read tickets",
|
|
14549
|
+
"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.",
|
|
14550
|
+
"http": "GET",
|
|
14551
|
+
"path": "/ticket/v1/tickets/{number}",
|
|
14552
|
+
"streaming": "no",
|
|
14553
|
+
"pagination": false,
|
|
14554
|
+
"pathParams": [
|
|
14555
|
+
{
|
|
14556
|
+
"name": "number",
|
|
14557
|
+
"sdkName": "number"
|
|
14558
|
+
}
|
|
14559
|
+
],
|
|
14560
|
+
"query": [
|
|
14561
|
+
{
|
|
14562
|
+
"name": "repository",
|
|
14563
|
+
"type": "string",
|
|
14564
|
+
"required": false,
|
|
14565
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14566
|
+
}
|
|
14567
|
+
]
|
|
14568
|
+
},
|
|
14569
|
+
{
|
|
14570
|
+
"resource": "ticket.tickets",
|
|
14571
|
+
"method": "update",
|
|
14572
|
+
"summary": "Update tickets",
|
|
14573
|
+
"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.",
|
|
14574
|
+
"http": "PATCH",
|
|
14575
|
+
"path": "/ticket/v1/tickets/{number}",
|
|
14576
|
+
"streaming": "no",
|
|
14577
|
+
"pagination": false,
|
|
14578
|
+
"pathParams": [
|
|
14579
|
+
{
|
|
14580
|
+
"name": "number",
|
|
14581
|
+
"sdkName": "number"
|
|
14582
|
+
}
|
|
14583
|
+
],
|
|
14584
|
+
"query": [
|
|
14585
|
+
{
|
|
14586
|
+
"name": "repository",
|
|
14587
|
+
"type": "string",
|
|
14588
|
+
"required": false,
|
|
14589
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14590
|
+
}
|
|
14591
|
+
],
|
|
14592
|
+
"body": {
|
|
14593
|
+
"required": true,
|
|
14594
|
+
"fields": [
|
|
14595
|
+
{
|
|
14596
|
+
"name": "title",
|
|
14597
|
+
"type": "string",
|
|
14598
|
+
"required": false,
|
|
14599
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
14600
|
+
},
|
|
14601
|
+
{
|
|
14602
|
+
"name": "body",
|
|
14603
|
+
"type": "string",
|
|
14604
|
+
"required": false,
|
|
14605
|
+
"description": "Markdown text, at most 65536 characters."
|
|
14606
|
+
},
|
|
14607
|
+
{
|
|
14608
|
+
"name": "type",
|
|
14609
|
+
"type": "string",
|
|
14610
|
+
"required": false,
|
|
14611
|
+
"description": "Built-in type name; null clears an existing type."
|
|
14612
|
+
},
|
|
14613
|
+
{
|
|
14614
|
+
"name": "labels",
|
|
14615
|
+
"type": "array",
|
|
14616
|
+
"itemType": "string",
|
|
14617
|
+
"required": false,
|
|
14618
|
+
"description": "Labels attached to this ticket; updates replace the complete list."
|
|
14619
|
+
},
|
|
14620
|
+
{
|
|
14621
|
+
"name": "assignees",
|
|
14622
|
+
"type": "array",
|
|
14623
|
+
"itemType": "string",
|
|
14624
|
+
"required": false,
|
|
14625
|
+
"description": "Complete assignee list, at most ten."
|
|
14626
|
+
},
|
|
14627
|
+
{
|
|
14628
|
+
"name": "milestone",
|
|
14629
|
+
"type": "integer",
|
|
14630
|
+
"required": false,
|
|
14631
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
14632
|
+
},
|
|
14633
|
+
{
|
|
14634
|
+
"name": "state",
|
|
14635
|
+
"type": "string",
|
|
14636
|
+
"enum": [
|
|
14637
|
+
"open",
|
|
14638
|
+
"closed"
|
|
14639
|
+
],
|
|
14640
|
+
"required": false,
|
|
14641
|
+
"description": "open means actionable; closed means resolved or declined."
|
|
14642
|
+
},
|
|
14643
|
+
{
|
|
14644
|
+
"name": "state_reason",
|
|
14645
|
+
"type": "string",
|
|
14646
|
+
"enum": [
|
|
14647
|
+
"completed",
|
|
14648
|
+
"not_planned",
|
|
14649
|
+
"duplicate"
|
|
14650
|
+
],
|
|
14651
|
+
"required": false,
|
|
14652
|
+
"description": "Reason for closing: completed resolves, not_planned declines, duplicate marks a duplicate."
|
|
14653
|
+
},
|
|
14654
|
+
{
|
|
14655
|
+
"name": "duplicate_of",
|
|
14656
|
+
"type": "integer",
|
|
14657
|
+
"required": false,
|
|
14658
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
14659
|
+
}
|
|
14660
|
+
]
|
|
14661
|
+
}
|
|
14662
|
+
},
|
|
14663
|
+
{
|
|
14664
|
+
"resource": "ticket.tickets.comments",
|
|
14665
|
+
"method": "list",
|
|
14666
|
+
"summary": "List comments",
|
|
14667
|
+
"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.",
|
|
14668
|
+
"http": "GET",
|
|
14669
|
+
"path": "/ticket/v1/tickets/{number}/comments",
|
|
14670
|
+
"streaming": "no",
|
|
14671
|
+
"pagination": false,
|
|
14672
|
+
"pathParams": [
|
|
14673
|
+
{
|
|
14674
|
+
"name": "number",
|
|
14675
|
+
"sdkName": "number"
|
|
14676
|
+
}
|
|
14677
|
+
],
|
|
14678
|
+
"query": [
|
|
14679
|
+
{
|
|
14680
|
+
"name": "repository",
|
|
14681
|
+
"type": "string",
|
|
14682
|
+
"required": false,
|
|
14683
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14684
|
+
},
|
|
14685
|
+
{
|
|
14686
|
+
"name": "page_size",
|
|
14687
|
+
"type": "integer",
|
|
14688
|
+
"required": false,
|
|
14689
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14690
|
+
},
|
|
14691
|
+
{
|
|
14692
|
+
"name": "page_token",
|
|
14693
|
+
"type": "string",
|
|
14694
|
+
"required": false,
|
|
14695
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14696
|
+
}
|
|
14697
|
+
]
|
|
14698
|
+
},
|
|
14699
|
+
{
|
|
14700
|
+
"resource": "ticket.tickets.comments",
|
|
14701
|
+
"method": "create",
|
|
14702
|
+
"summary": "Create or add comments",
|
|
14703
|
+
"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.",
|
|
14704
|
+
"http": "POST",
|
|
14705
|
+
"path": "/ticket/v1/tickets/{number}/comments",
|
|
14706
|
+
"streaming": "no",
|
|
14707
|
+
"pagination": false,
|
|
14708
|
+
"pathParams": [
|
|
14709
|
+
{
|
|
14710
|
+
"name": "number",
|
|
14711
|
+
"sdkName": "number"
|
|
14712
|
+
}
|
|
14713
|
+
],
|
|
14714
|
+
"query": [
|
|
14715
|
+
{
|
|
14716
|
+
"name": "repository",
|
|
14717
|
+
"type": "string",
|
|
14718
|
+
"required": false,
|
|
14719
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14720
|
+
}
|
|
14721
|
+
],
|
|
14722
|
+
"body": {
|
|
14723
|
+
"required": true,
|
|
14724
|
+
"fields": [
|
|
14725
|
+
{
|
|
14726
|
+
"name": "body",
|
|
14727
|
+
"type": "string",
|
|
14728
|
+
"required": true,
|
|
14729
|
+
"description": "Markdown text, at most 65536 characters."
|
|
14730
|
+
},
|
|
14731
|
+
{
|
|
14732
|
+
"name": "in_reply_to",
|
|
14733
|
+
"type": "string",
|
|
14734
|
+
"required": false,
|
|
14735
|
+
"description": "Opaque identifier returned by this resource's create or list operation."
|
|
14736
|
+
}
|
|
14737
|
+
]
|
|
14738
|
+
}
|
|
14739
|
+
},
|
|
14740
|
+
{
|
|
14741
|
+
"resource": "ticket.tickets.dependencies",
|
|
14742
|
+
"method": "retrieveBlockedBy",
|
|
14743
|
+
"summary": "List blocked by",
|
|
14744
|
+
"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.",
|
|
14745
|
+
"http": "GET",
|
|
14746
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocked_by",
|
|
14747
|
+
"streaming": "no",
|
|
14748
|
+
"pagination": false,
|
|
14749
|
+
"pathParams": [
|
|
14750
|
+
{
|
|
14751
|
+
"name": "number",
|
|
14752
|
+
"sdkName": "number"
|
|
14753
|
+
}
|
|
14754
|
+
],
|
|
14755
|
+
"query": [
|
|
14756
|
+
{
|
|
14757
|
+
"name": "repository",
|
|
14758
|
+
"type": "string",
|
|
14759
|
+
"required": false,
|
|
14760
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14761
|
+
},
|
|
14762
|
+
{
|
|
14763
|
+
"name": "page_size",
|
|
14764
|
+
"type": "integer",
|
|
14765
|
+
"required": false,
|
|
14766
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14767
|
+
},
|
|
14768
|
+
{
|
|
14769
|
+
"name": "page_token",
|
|
14770
|
+
"type": "string",
|
|
14771
|
+
"required": false,
|
|
14772
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14773
|
+
}
|
|
14774
|
+
]
|
|
14775
|
+
},
|
|
14776
|
+
{
|
|
14777
|
+
"resource": "ticket.tickets.dependencies.blockedBy",
|
|
14778
|
+
"method": "create",
|
|
14779
|
+
"summary": "Create or add blocked by",
|
|
14780
|
+
"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.",
|
|
14781
|
+
"http": "POST",
|
|
14782
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocked_by",
|
|
14783
|
+
"streaming": "no",
|
|
14784
|
+
"pagination": false,
|
|
14785
|
+
"pathParams": [
|
|
14786
|
+
{
|
|
14787
|
+
"name": "number",
|
|
14788
|
+
"sdkName": "number"
|
|
14789
|
+
}
|
|
14790
|
+
],
|
|
14791
|
+
"query": [
|
|
14792
|
+
{
|
|
14793
|
+
"name": "repository",
|
|
14794
|
+
"type": "string",
|
|
14795
|
+
"required": false,
|
|
14796
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14797
|
+
}
|
|
14798
|
+
],
|
|
14799
|
+
"body": {
|
|
14800
|
+
"required": true,
|
|
14801
|
+
"fields": [
|
|
14802
|
+
{
|
|
14803
|
+
"name": "blocked_by",
|
|
14804
|
+
"type": "integer",
|
|
14805
|
+
"required": true,
|
|
14806
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
14807
|
+
}
|
|
14808
|
+
]
|
|
14809
|
+
}
|
|
14810
|
+
},
|
|
14811
|
+
{
|
|
14812
|
+
"resource": "ticket.tickets.dependencies.blockedBy",
|
|
14813
|
+
"method": "delete",
|
|
14814
|
+
"summary": "Remove blocked by",
|
|
14815
|
+
"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.",
|
|
14816
|
+
"http": "DELETE",
|
|
14817
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocked_by/{n}",
|
|
14818
|
+
"streaming": "no",
|
|
14819
|
+
"pagination": false,
|
|
14820
|
+
"pathParams": [
|
|
14821
|
+
{
|
|
14822
|
+
"name": "number",
|
|
14823
|
+
"sdkName": "number"
|
|
14824
|
+
},
|
|
14825
|
+
{
|
|
14826
|
+
"name": "n",
|
|
14827
|
+
"sdkName": "n"
|
|
14828
|
+
}
|
|
14829
|
+
],
|
|
14830
|
+
"query": [
|
|
14831
|
+
{
|
|
14832
|
+
"name": "repository",
|
|
14833
|
+
"type": "string",
|
|
14834
|
+
"required": false,
|
|
14835
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14836
|
+
}
|
|
14837
|
+
]
|
|
14838
|
+
},
|
|
14839
|
+
{
|
|
14840
|
+
"resource": "ticket.tickets.dependencies",
|
|
14841
|
+
"method": "retrieveBlocking",
|
|
14842
|
+
"summary": "List blocking",
|
|
14843
|
+
"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.",
|
|
14844
|
+
"http": "GET",
|
|
14845
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocking",
|
|
14846
|
+
"streaming": "no",
|
|
14847
|
+
"pagination": false,
|
|
14848
|
+
"pathParams": [
|
|
14849
|
+
{
|
|
14850
|
+
"name": "number",
|
|
14851
|
+
"sdkName": "number"
|
|
14852
|
+
}
|
|
14853
|
+
],
|
|
14854
|
+
"query": [
|
|
14855
|
+
{
|
|
14856
|
+
"name": "repository",
|
|
14857
|
+
"type": "string",
|
|
14858
|
+
"required": false,
|
|
14859
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14860
|
+
},
|
|
14861
|
+
{
|
|
14862
|
+
"name": "page_size",
|
|
14863
|
+
"type": "integer",
|
|
14864
|
+
"required": false,
|
|
14865
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14866
|
+
},
|
|
14867
|
+
{
|
|
14868
|
+
"name": "page_token",
|
|
14869
|
+
"type": "string",
|
|
14870
|
+
"required": false,
|
|
14871
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14872
|
+
}
|
|
14873
|
+
]
|
|
14874
|
+
},
|
|
14875
|
+
{
|
|
14876
|
+
"resource": "ticket.tickets.events",
|
|
14877
|
+
"method": "list",
|
|
14878
|
+
"summary": "List events",
|
|
14879
|
+
"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.",
|
|
14880
|
+
"http": "GET",
|
|
14881
|
+
"path": "/ticket/v1/tickets/{number}/events",
|
|
14882
|
+
"streaming": "no",
|
|
14883
|
+
"pagination": false,
|
|
14884
|
+
"pathParams": [
|
|
14885
|
+
{
|
|
14886
|
+
"name": "number",
|
|
14887
|
+
"sdkName": "number"
|
|
14888
|
+
}
|
|
14889
|
+
],
|
|
14890
|
+
"query": [
|
|
14891
|
+
{
|
|
14892
|
+
"name": "repository",
|
|
14893
|
+
"type": "string",
|
|
14894
|
+
"required": false,
|
|
14895
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14896
|
+
},
|
|
14897
|
+
{
|
|
14898
|
+
"name": "page_size",
|
|
14899
|
+
"type": "integer",
|
|
14900
|
+
"required": false,
|
|
14901
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14902
|
+
},
|
|
14903
|
+
{
|
|
14904
|
+
"name": "page_token",
|
|
14905
|
+
"type": "string",
|
|
14906
|
+
"required": false,
|
|
14907
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14908
|
+
}
|
|
14909
|
+
]
|
|
14910
|
+
},
|
|
14911
|
+
{
|
|
14912
|
+
"resource": "ticket.tickets",
|
|
14913
|
+
"method": "deleteLock",
|
|
14914
|
+
"summary": "Remove lock",
|
|
14915
|
+
"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.",
|
|
14916
|
+
"http": "DELETE",
|
|
14917
|
+
"path": "/ticket/v1/tickets/{number}/lock",
|
|
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
|
+
},
|
|
14935
|
+
{
|
|
14936
|
+
"resource": "ticket.tickets",
|
|
14937
|
+
"method": "updateLock",
|
|
14938
|
+
"summary": "Update lock",
|
|
14939
|
+
"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.",
|
|
14940
|
+
"http": "PUT",
|
|
14941
|
+
"path": "/ticket/v1/tickets/{number}/lock",
|
|
14942
|
+
"streaming": "no",
|
|
14943
|
+
"pagination": false,
|
|
14944
|
+
"pathParams": [
|
|
14945
|
+
{
|
|
14946
|
+
"name": "number",
|
|
14947
|
+
"sdkName": "number"
|
|
14948
|
+
}
|
|
14949
|
+
],
|
|
14950
|
+
"query": [
|
|
14951
|
+
{
|
|
14952
|
+
"name": "repository",
|
|
14953
|
+
"type": "string",
|
|
14954
|
+
"required": false,
|
|
14955
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14956
|
+
}
|
|
14957
|
+
],
|
|
14958
|
+
"body": {
|
|
14959
|
+
"required": false,
|
|
14960
|
+
"fields": [
|
|
14961
|
+
{
|
|
14962
|
+
"name": "lock_reason",
|
|
14963
|
+
"type": "string",
|
|
14964
|
+
"enum": [
|
|
14965
|
+
"off-topic",
|
|
14966
|
+
"too heated",
|
|
14967
|
+
"resolved",
|
|
14968
|
+
"spam"
|
|
14969
|
+
],
|
|
14970
|
+
"required": false,
|
|
14971
|
+
"description": "Reason for locking: off-topic, too heated, resolved, or spam."
|
|
14972
|
+
}
|
|
14973
|
+
]
|
|
14974
|
+
}
|
|
14975
|
+
},
|
|
14976
|
+
{
|
|
14977
|
+
"resource": "ticket.tickets.reactions",
|
|
14978
|
+
"method": "list",
|
|
14979
|
+
"summary": "List reactions",
|
|
14980
|
+
"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.",
|
|
14981
|
+
"http": "GET",
|
|
14982
|
+
"path": "/ticket/v1/tickets/{number}/reactions",
|
|
14983
|
+
"streaming": "no",
|
|
14984
|
+
"pagination": false,
|
|
14985
|
+
"pathParams": [
|
|
14986
|
+
{
|
|
14987
|
+
"name": "number",
|
|
14988
|
+
"sdkName": "number"
|
|
14989
|
+
}
|
|
14990
|
+
],
|
|
14991
|
+
"query": [
|
|
14992
|
+
{
|
|
14993
|
+
"name": "repository",
|
|
14994
|
+
"type": "string",
|
|
14995
|
+
"required": false,
|
|
14996
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14997
|
+
},
|
|
14998
|
+
{
|
|
14999
|
+
"name": "page_size",
|
|
15000
|
+
"type": "integer",
|
|
15001
|
+
"required": false,
|
|
15002
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15003
|
+
},
|
|
15004
|
+
{
|
|
15005
|
+
"name": "page_token",
|
|
15006
|
+
"type": "string",
|
|
15007
|
+
"required": false,
|
|
15008
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15009
|
+
}
|
|
15010
|
+
]
|
|
15011
|
+
},
|
|
15012
|
+
{
|
|
15013
|
+
"resource": "ticket.tickets.reactions",
|
|
15014
|
+
"method": "create",
|
|
15015
|
+
"summary": "Create or add reactions",
|
|
15016
|
+
"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.",
|
|
15017
|
+
"http": "POST",
|
|
15018
|
+
"path": "/ticket/v1/tickets/{number}/reactions",
|
|
15019
|
+
"streaming": "no",
|
|
15020
|
+
"pagination": false,
|
|
15021
|
+
"pathParams": [
|
|
15022
|
+
{
|
|
15023
|
+
"name": "number",
|
|
15024
|
+
"sdkName": "number"
|
|
15025
|
+
}
|
|
15026
|
+
],
|
|
15027
|
+
"query": [
|
|
15028
|
+
{
|
|
15029
|
+
"name": "repository",
|
|
15030
|
+
"type": "string",
|
|
15031
|
+
"required": false,
|
|
15032
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15033
|
+
}
|
|
15034
|
+
],
|
|
15035
|
+
"body": {
|
|
15036
|
+
"required": true,
|
|
15037
|
+
"fields": [
|
|
15038
|
+
{
|
|
15039
|
+
"name": "content",
|
|
15040
|
+
"type": "string",
|
|
15041
|
+
"enum": [
|
|
15042
|
+
"+1",
|
|
15043
|
+
"-1",
|
|
15044
|
+
"laugh",
|
|
15045
|
+
"confused",
|
|
15046
|
+
"heart",
|
|
15047
|
+
"hooray",
|
|
15048
|
+
"eyes",
|
|
15049
|
+
"rocket"
|
|
15050
|
+
],
|
|
15051
|
+
"required": true,
|
|
15052
|
+
"description": "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket."
|
|
15053
|
+
}
|
|
15054
|
+
]
|
|
15055
|
+
}
|
|
15056
|
+
},
|
|
15057
|
+
{
|
|
15058
|
+
"resource": "ticket.tickets.reactions",
|
|
15059
|
+
"method": "delete",
|
|
15060
|
+
"summary": "Remove reactions",
|
|
15061
|
+
"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.",
|
|
15062
|
+
"http": "DELETE",
|
|
15063
|
+
"path": "/ticket/v1/tickets/{number}/reactions/{content}",
|
|
15064
|
+
"streaming": "no",
|
|
15065
|
+
"pagination": false,
|
|
15066
|
+
"pathParams": [
|
|
15067
|
+
{
|
|
15068
|
+
"name": "number",
|
|
15069
|
+
"sdkName": "number"
|
|
15070
|
+
},
|
|
15071
|
+
{
|
|
15072
|
+
"name": "content",
|
|
15073
|
+
"sdkName": "content"
|
|
15074
|
+
}
|
|
15075
|
+
],
|
|
15076
|
+
"query": [
|
|
15077
|
+
{
|
|
15078
|
+
"name": "repository",
|
|
15079
|
+
"type": "string",
|
|
15080
|
+
"required": false,
|
|
15081
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15082
|
+
}
|
|
15083
|
+
]
|
|
15084
|
+
},
|
|
15085
|
+
{
|
|
15086
|
+
"resource": "ticket.tickets.relations",
|
|
15087
|
+
"method": "list",
|
|
15088
|
+
"summary": "List relations",
|
|
15089
|
+
"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.",
|
|
15090
|
+
"http": "GET",
|
|
15091
|
+
"path": "/ticket/v1/tickets/{number}/relations",
|
|
15092
|
+
"streaming": "no",
|
|
15093
|
+
"pagination": false,
|
|
15094
|
+
"pathParams": [
|
|
15095
|
+
{
|
|
15096
|
+
"name": "number",
|
|
15097
|
+
"sdkName": "number"
|
|
15098
|
+
}
|
|
15099
|
+
],
|
|
15100
|
+
"query": [
|
|
15101
|
+
{
|
|
15102
|
+
"name": "repository",
|
|
15103
|
+
"type": "string",
|
|
15104
|
+
"required": false,
|
|
15105
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15106
|
+
},
|
|
15107
|
+
{
|
|
15108
|
+
"name": "page_size",
|
|
15109
|
+
"type": "integer",
|
|
15110
|
+
"required": false,
|
|
15111
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15112
|
+
},
|
|
15113
|
+
{
|
|
15114
|
+
"name": "page_token",
|
|
15115
|
+
"type": "string",
|
|
15116
|
+
"required": false,
|
|
15117
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15118
|
+
}
|
|
15119
|
+
]
|
|
15120
|
+
},
|
|
15121
|
+
{
|
|
15122
|
+
"resource": "ticket.tickets.relations",
|
|
15123
|
+
"method": "create",
|
|
15124
|
+
"summary": "Create or add relations",
|
|
15125
|
+
"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.",
|
|
15126
|
+
"http": "POST",
|
|
15127
|
+
"path": "/ticket/v1/tickets/{number}/relations",
|
|
15128
|
+
"streaming": "no",
|
|
15129
|
+
"pagination": false,
|
|
15130
|
+
"pathParams": [
|
|
15131
|
+
{
|
|
15132
|
+
"name": "number",
|
|
15133
|
+
"sdkName": "number"
|
|
15134
|
+
}
|
|
15135
|
+
],
|
|
15136
|
+
"query": [
|
|
15137
|
+
{
|
|
15138
|
+
"name": "repository",
|
|
15139
|
+
"type": "string",
|
|
15140
|
+
"required": false,
|
|
15141
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15142
|
+
}
|
|
15143
|
+
],
|
|
15144
|
+
"body": {
|
|
15145
|
+
"required": true,
|
|
15146
|
+
"fields": [
|
|
15147
|
+
{
|
|
15148
|
+
"name": "relates_to",
|
|
15149
|
+
"type": "integer",
|
|
15150
|
+
"required": true,
|
|
15151
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
15152
|
+
}
|
|
15153
|
+
]
|
|
15154
|
+
}
|
|
15155
|
+
},
|
|
15156
|
+
{
|
|
15157
|
+
"resource": "ticket.tickets.relations",
|
|
15158
|
+
"method": "delete",
|
|
15159
|
+
"summary": "Remove relations",
|
|
15160
|
+
"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.",
|
|
15161
|
+
"http": "DELETE",
|
|
15162
|
+
"path": "/ticket/v1/tickets/{number}/relations/{n}",
|
|
15163
|
+
"streaming": "no",
|
|
15164
|
+
"pagination": false,
|
|
15165
|
+
"pathParams": [
|
|
15166
|
+
{
|
|
15167
|
+
"name": "number",
|
|
15168
|
+
"sdkName": "number"
|
|
15169
|
+
},
|
|
15170
|
+
{
|
|
15171
|
+
"name": "n",
|
|
15172
|
+
"sdkName": "n"
|
|
15173
|
+
}
|
|
15174
|
+
],
|
|
15175
|
+
"query": [
|
|
15176
|
+
{
|
|
15177
|
+
"name": "repository",
|
|
15178
|
+
"type": "string",
|
|
15179
|
+
"required": false,
|
|
15180
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15181
|
+
}
|
|
15182
|
+
]
|
|
15183
|
+
},
|
|
15184
|
+
{
|
|
15185
|
+
"resource": "ticket.tickets.subTickets",
|
|
15186
|
+
"method": "list",
|
|
15187
|
+
"summary": "List sub tickets",
|
|
15188
|
+
"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.",
|
|
15189
|
+
"http": "GET",
|
|
15190
|
+
"path": "/ticket/v1/tickets/{number}/sub_tickets",
|
|
15191
|
+
"streaming": "no",
|
|
15192
|
+
"pagination": false,
|
|
15193
|
+
"pathParams": [
|
|
15194
|
+
{
|
|
15195
|
+
"name": "number",
|
|
15196
|
+
"sdkName": "number"
|
|
15197
|
+
}
|
|
15198
|
+
],
|
|
15199
|
+
"query": [
|
|
15200
|
+
{
|
|
15201
|
+
"name": "repository",
|
|
15202
|
+
"type": "string",
|
|
15203
|
+
"required": false,
|
|
15204
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15205
|
+
},
|
|
15206
|
+
{
|
|
15207
|
+
"name": "page_size",
|
|
15208
|
+
"type": "integer",
|
|
15209
|
+
"required": false,
|
|
15210
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15211
|
+
},
|
|
15212
|
+
{
|
|
15213
|
+
"name": "page_token",
|
|
15214
|
+
"type": "string",
|
|
15215
|
+
"required": false,
|
|
15216
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15217
|
+
}
|
|
15218
|
+
]
|
|
15219
|
+
},
|
|
15220
|
+
{
|
|
15221
|
+
"resource": "ticket.tickets.subTickets",
|
|
15222
|
+
"method": "create",
|
|
15223
|
+
"summary": "Create or add sub tickets",
|
|
15224
|
+
"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.",
|
|
15225
|
+
"http": "POST",
|
|
15226
|
+
"path": "/ticket/v1/tickets/{number}/sub_tickets",
|
|
15227
|
+
"streaming": "no",
|
|
15228
|
+
"pagination": false,
|
|
15229
|
+
"pathParams": [
|
|
15230
|
+
{
|
|
15231
|
+
"name": "number",
|
|
15232
|
+
"sdkName": "number"
|
|
15233
|
+
}
|
|
15234
|
+
],
|
|
15235
|
+
"query": [
|
|
15236
|
+
{
|
|
15237
|
+
"name": "repository",
|
|
15238
|
+
"type": "string",
|
|
15239
|
+
"required": false,
|
|
15240
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15241
|
+
}
|
|
15242
|
+
],
|
|
15243
|
+
"body": {
|
|
15244
|
+
"required": true,
|
|
15245
|
+
"fields": [
|
|
15246
|
+
{
|
|
15247
|
+
"name": "child",
|
|
15248
|
+
"type": "integer",
|
|
15249
|
+
"required": true,
|
|
15250
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
15251
|
+
},
|
|
15252
|
+
{
|
|
15253
|
+
"name": "replace_parent",
|
|
15254
|
+
"type": "boolean",
|
|
15255
|
+
"required": false,
|
|
15256
|
+
"description": "Allow replacing an existing parent."
|
|
15257
|
+
}
|
|
15258
|
+
]
|
|
15259
|
+
}
|
|
15260
|
+
},
|
|
15261
|
+
{
|
|
15262
|
+
"resource": "ticket.tickets.subTickets",
|
|
15263
|
+
"method": "delete",
|
|
15264
|
+
"summary": "Remove sub tickets",
|
|
15265
|
+
"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.",
|
|
15266
|
+
"http": "DELETE",
|
|
15267
|
+
"path": "/ticket/v1/tickets/{number}/sub_tickets/{child}",
|
|
15268
|
+
"streaming": "no",
|
|
15269
|
+
"pagination": false,
|
|
15270
|
+
"pathParams": [
|
|
15271
|
+
{
|
|
15272
|
+
"name": "number",
|
|
15273
|
+
"sdkName": "number"
|
|
15274
|
+
},
|
|
15275
|
+
{
|
|
15276
|
+
"name": "child",
|
|
15277
|
+
"sdkName": "child"
|
|
15278
|
+
}
|
|
15279
|
+
],
|
|
15280
|
+
"query": [
|
|
15281
|
+
{
|
|
15282
|
+
"name": "repository",
|
|
15283
|
+
"type": "string",
|
|
15284
|
+
"required": false,
|
|
15285
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15286
|
+
}
|
|
15287
|
+
]
|
|
15288
|
+
},
|
|
15289
|
+
{
|
|
15290
|
+
"resource": "ticket.types",
|
|
15291
|
+
"method": "list",
|
|
15292
|
+
"summary": "Read types",
|
|
15293
|
+
"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.",
|
|
15294
|
+
"http": "GET",
|
|
15295
|
+
"path": "/ticket/v1/types",
|
|
15296
|
+
"streaming": "no",
|
|
15297
|
+
"pagination": false,
|
|
15298
|
+
"pathParams": [],
|
|
15299
|
+
"query": [
|
|
15300
|
+
{
|
|
15301
|
+
"name": "repository",
|
|
15302
|
+
"type": "string",
|
|
15303
|
+
"required": false,
|
|
15304
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15305
|
+
}
|
|
15306
|
+
]
|
|
15307
|
+
},
|
|
13660
15308
|
{
|
|
13661
15309
|
"resource": "vault.authorizations",
|
|
13662
15310
|
"method": "create",
|