Skip to content

Commit

Permalink
feat(docs): update docs (#760)
Browse files Browse the repository at this point in the history
feat(docs): update docs

Updates the Wing docs. See details in [workflow run].

[Workflow Run]: https://github.com/winglang/docsite/actions/runs/7518633176

------

*Automatically created via the "update-docs" workflow*
  • Loading branch information
monadabot authored Jan 14, 2024
1 parent 4d794d4 commit 825d238
Showing 1 changed file with 44 additions and 2 deletions.
46 changes: 44 additions & 2 deletions versioned_docs/version-latest/04-standard-library/cloud/bucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -855,7 +855,21 @@ let BucketSignedUrlOptions = cloud.BucketSignedUrlOptions{ ... };

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#@winglang/sdk.cloud.BucketSignedUrlOptions.property.duration">duration</a></code> | <code><a href="#@winglang/sdk.std.Duration">duration</a></code> | The duration for the signed url to expire. |
| <code><a href="#@winglang/sdk.cloud.BucketSignedUrlOptions.property.action">action</a></code> | <code><a href="#@winglang/sdk.cloud.BucketSignedUrlAction">BucketSignedUrlAction</a></code> | The action allowed by the signed URL. |
| <code><a href="#@winglang/sdk.cloud.BucketSignedUrlOptions.property.duration">duration</a></code> | <code><a href="#@winglang/sdk.std.Duration">duration</a></code> | The duration for the signed URL to expire. |

---

##### `action`<sup>Optional</sup> <a name="action" id="@winglang/sdk.cloud.BucketSignedUrlOptions.property.action"></a>

```wing
action: BucketSignedUrlAction;
```

- *Type:* <a href="#@winglang/sdk.cloud.BucketSignedUrlAction">BucketSignedUrlAction</a>
- *Default:* BucketSignedUrlAction.DOWNLOAD

The action allowed by the signed URL.

---

Expand All @@ -866,8 +880,9 @@ duration: duration;
```

- *Type:* <a href="#@winglang/sdk.std.Duration">duration</a>
- *Default:* 15m

The duration for the signed url to expire.
The duration for the signed URL to expire.

---

Expand Down Expand Up @@ -1014,3 +1029,30 @@ Update.

---


### BucketSignedUrlAction <a name="BucketSignedUrlAction" id="@winglang/sdk.cloud.BucketSignedUrlAction"></a>

Specifies the action permitted by a presigned URL for a bucket.

#### Members <a name="Members" id="Members"></a>

| **Name** | **Description** |
| --- | --- |
| <code><a href="#@winglang/sdk.cloud.BucketSignedUrlAction.DOWNLOAD">DOWNLOAD</a></code> | Represents a HTTP GET request for a presigned URL, allowing read access for an object in the bucket. |
| <code><a href="#@winglang/sdk.cloud.BucketSignedUrlAction.UPLOAD">UPLOAD</a></code> | Represents a HTTP PUT request for a presigned URL, allowing write access for an object in the bucket. |

---

##### `DOWNLOAD` <a name="DOWNLOAD" id="@winglang/sdk.cloud.BucketSignedUrlAction.DOWNLOAD"></a>

Represents a HTTP GET request for a presigned URL, allowing read access for an object in the bucket.

---


##### `UPLOAD` <a name="UPLOAD" id="@winglang/sdk.cloud.BucketSignedUrlAction.UPLOAD"></a>

Represents a HTTP PUT request for a presigned URL, allowing write access for an object in the bucket.

---

1 comment on commit 825d238

@vercel
Copy link

@vercel vercel bot commented on 825d238 Jan 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.