@leaflow/sdk 0.36.0 → 0.37.0

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.
@@ -36,8 +36,8 @@ export type ListTicketCategoriesQuery = operations["list-ticket-categories"]["pa
36
36
  export type UploadAttachmentResult = operations["upload-attachment"]["responses"][201]["content"]["application/json"];
37
37
  /** `POST /api/v1/attachments` 的查询参数。 */
38
38
  export type UploadAttachmentQuery = operations["upload-attachment"]["parameters"]["query"];
39
- /** `GET /api/v1/attachments/{attachmentId}/download-url` 成功时的响应体。 */
40
- export type DescribeAttachmentDownloadResult = operations["describe-attachment-download"]["responses"][200]["content"]["application/json"];
39
+ /** `GET /api/v1/attachments/{attachmentId}/content` 的查询参数。 */
40
+ export type DownloadAttachmentQuery = operations["download-attachment"]["parameters"]["query"];
41
41
  /** `GET /api/v1/maintenances` 成功时的响应体。 */
42
42
  export type ListMaintenancesResult = operations["list-maintenances"]["responses"][200]["content"]["application/json"];
43
43
  /** `GET /api/v1/maintenances` 的查询参数。 */
@@ -202,7 +202,7 @@ export interface paths {
202
202
  patch?: never;
203
203
  trace?: never;
204
204
  };
205
- "/api/v1/attachments/{attachmentId}/download-url": {
205
+ "/api/v1/attachments/{attachmentId}/content": {
206
206
  parameters: {
207
207
  query?: never;
208
208
  header?: never;
@@ -210,13 +210,16 @@ export interface paths {
210
210
  cookie?: never;
211
211
  };
212
212
  /**
213
- * Get a download address for an attachment
214
- * @description Returns a temporary address that serves the file. The address expires; request a new one
215
- * rather than storing it.
213
+ * Download an attachment
214
+ * @description Serves the file itself. The bytes are proxied by this API; the object store is not reachable
215
+ * from outside, and no address to it is ever handed out.
216
216
  *
217
- * Returns 404 for an attachment uploaded in another project.
217
+ * `Content-Type` is the type determined from the content at upload time, not the one the
218
+ * client claimed. `Content-Disposition` is `attachment` unless `inline` is requested **and**
219
+ * the content type is one that can be rendered safely, in which case it is `inline`. Asking
220
+ * for `inline` on anything else still yields a download.
218
221
  */
219
- get: operations["describe-attachment-download"];
222
+ get: operations["download-attachment"];
220
223
  put?: never;
221
224
  post?: never;
222
225
  delete?: never;
@@ -469,15 +472,6 @@ export interface components {
469
472
  status: components["schemas"]["MaintenanceStatus"];
470
473
  title: string;
471
474
  };
472
- AttachmentDownloadResource: {
473
- /**
474
- * Format: date-time
475
- * @description After this moment the address stops working; request a new one
476
- */
477
- expires_at: string;
478
- /** @description A temporary address serving the file */
479
- url: string;
480
- };
481
475
  CreateTicketRequestBody: {
482
476
  /** @description Attachments to reference from the first message. Each must have been uploaded in this project and not yet referenced */
483
477
  attachment_ids?: string[];
@@ -940,9 +934,12 @@ export interface operations {
940
934
  };
941
935
  };
942
936
  };
943
- "describe-attachment-download": {
937
+ "download-attachment": {
944
938
  parameters: {
945
- query?: never;
939
+ query?: {
940
+ /** @description Render in the browser instead of downloading, where the content type allows it */
941
+ inline?: boolean;
942
+ };
946
943
  header?: never;
947
944
  path: {
948
945
  attachmentId: string;
@@ -954,10 +951,12 @@ export interface operations {
954
951
  /** @description OK */
955
952
  200: {
956
953
  headers: {
954
+ /** @description `inline` when the content type can be rendered safely and `inline` was asked for, `attachment` otherwise. Carries the original file name */
955
+ "Content-Disposition"?: string;
957
956
  [name: string]: unknown;
958
957
  };
959
958
  content: {
960
- "application/json": components["schemas"]["AttachmentDownloadResource"];
959
+ "*/*": string;
961
960
  };
962
961
  };
963
962
  /** @description Error */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@leaflow/sdk",
3
- "version": "0.36.0",
3
+ "version": "0.37.0",
4
4
  "description": "Leaflow 平台 API 的 TypeScript SDK",
5
5
  "license": "MIT",
6
6
  "repository": {