Skip to content

Commit be33931

Browse files
committed
object storage documentation updates
1 parent 577941b commit be33931

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

docs/object_storage/namespaces.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ The following attributes are exported:
1111

1212

1313
### Get Operation
14-
Gets the name of the namespace for the user making the request. An account name must be unique, must start with a
15-
letter, and can have up to 15 lowercase letters and numbers. You cannot use spaces or special characters.
14+
Namespaces are unique. Namespaces are either the tenancy name or a random string automatically generated during
15+
account creation. You cannot edit a namespace.
1616

1717

1818
The following arguments are supported:

docs/object_storage/preauthenticated_requests.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,30 @@
66

77
The following attributes are exported:
88

9-
* `access_type` - the operation that can be performed on this resource e.g PUT or GET.
9+
* `access_type` - The operation that can be performed on this resource.
1010
* `access_uri` - The URI to embed in the URL when using the pre-authenticated request.
11-
* `bucket` - (Required) The name of the bucket. Example: `my-new-bucket1`
12-
* `id` - the unique identifier to use when directly addressing the pre-authenticated request
13-
* `name` - the user supplied name of the pre-authenticated request
14-
* `namespace` - (Required) The top-level namespace used for the request.
15-
* `object` - Name of object that is being granted access to by the pre-authenticated request. This can be null and that would mean that the pre-authenticated request is granting access to the entire bucket
16-
* `time_created` - the date when the pre-authenticated request was created as per spec [RFC 3339](https://tools.ietf.org/rfc/rfc3339)
17-
* `time_expires` - the expiration date after which the pre authenticated request will no longer be valid as per spec [RFC 3339](https://tools.ietf.org/rfc/rfc3339)
11+
* `bucket` - The name of the bucket. Example: `my-new-bucket1`
12+
* `id` - The unique identifier to use when directly addressing the pre-authenticated request.
13+
* `name` - The user-provided name of the pre-authenticated request.
14+
* `namespace` - The top-level namespace used for the request.
15+
* `object` - The name of object that is being granted access to by the pre-authenticated request. This can be null and if it is, the pre-authenticated request grants access to the entire bucket.
16+
* `time_created` - The date when the pre-authenticated request was created as per [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
17+
* `time_expires` - The expiration date for the pre-authenticated request as per [RFC 3339](https://tools.ietf.org/rfc/rfc3339). After this date the pre-authenticated request will no longer be valid.
1818

1919

2020

2121
### Create Operation
22-
Create a pre-authenticated request specific to the bucket
22+
Creates a pre-authenticated request specific to the bucket.
2323

2424

2525
The following arguments are supported:
2626

27-
* `access_type` - (Required) the operation that can be performed on this resource e.g PUT or GET.
28-
* `bucket` - (Required) The name of the bucket. Example: `my-new-bucket1`
29-
* `name` - (Required) user specified name for pre-authenticated request. Helpful for management purposes.
27+
* `access_type` - (Required) The operation that can be performed on this resource.
28+
* `bucket` - (Required) The name of the bucket. Avoid entering confidential information. Example: `my-new-bucket1`
29+
* `name` - (Required) A user-specified name for the pre-authenticated request. Helpful for management purposes.
3030
* `namespace` - (Required) The top-level namespace used for the request.
31-
* `object` - (Optional) Name of object that is being granted access to by the pre-authenticated request. This can be null and that would mean that the pre-authenticated request is granting access to the entire bucket
32-
* `time_expires` - (Required) The expiration date after which the pre-authenticated request will no longer be valid per spec [RFC 3339](https://tools.ietf.org/rfc/rfc3339)
31+
* `object` - (Optional) The name of object that is being granted access to by the pre-authenticated request. This can be null and if it is, the pre-authenticated request grants access to the entire bucket.
32+
* `time_expires` - (Required) The expiration date for the pre-authenticated request as per [RFC 3339](https://tools.ietf.org/rfc/rfc3339). After this date the pre-authenticated request will no longer be valid.
3333

3434

3535
### Update Operation

0 commit comments

Comments
 (0)