Skip to content
This repository has been archived by the owner on Sep 17, 2024. It is now read-only.

Fix docblocks and updated ObjectsApi documentation #27

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/Api/ObjectsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ $object_name = "object_name_example"; // string | URL-encoded object name
$content_length = 56; // int | Indicates the size of the request body.
$content_range = "content_range_example"; // string | Byte range of a segment being uploaded
$session_id = "session_id_example"; // string | Unique identifier of a session of a file being uploaded
$body = "/path/to/file.txt"; // \SplFileObject |
$body = file_get_contents("/path/to/file.txt"); // string | The content of the file to send
$content_disposition = "content_disposition_example"; // string | The suggested default filename when downloading this object to a file after it has been uploaded.
$if_match = "if_match_example"; // string | If-Match header containing a SHA-1 hash of the bytes in the request body can be sent by the calling service or client application with the request. If present, OSS will use the value of If-Match header to verify that a SHA-1 calculated for the uploaded bytes server side matches what was sent in the header. If not, the request is failed with a status 412 Precondition Failed and the data is not written.

Expand Down Expand Up @@ -546,7 +546,7 @@ $apiInstance = new Autodesk\Forge\Client\Api\ObjectsApi($authObject);
$bucket_key = "bucket_key_example"; // string | URL-encoded bucket key
$object_name = "object_name_example"; // string | URL-encoded object name
$content_length = 56; // int | Indicates the size of the request body.
$body = "/path/to/file.txt"; // \SplFileObject |
$body = file_get_contents("/path/to/file.txt"); // string | The content of the file to send
$content_disposition = "content_disposition_example"; // string | The suggested default filename when downloading this object to a file after it has been uploaded.
$if_match = "if_match_example"; // string | If-Match header containing a SHA-1 hash of the bytes in the request body can be sent by the calling service or client application with the request. If present, OSS will use the value of If-Match header to verify that a SHA-1 calculated for the uploaded bytes server side matches what was sent in the header. If not, the request is failed with a status 412 Precondition Failed and the data is not written.

Expand Down Expand Up @@ -600,7 +600,7 @@ require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Autodesk\Forge\Client\Api\ObjectsApi($authObject);
$id = "id_example"; // string | Id of signed resource
$content_length = 56; // int | Indicates the size of the request body.
$body = "/path/to/file.txt"; // \SplFileObject |
$body = file_get_contents("/path/to/file.txt"); // string | The content of the file to send
$content_disposition = "content_disposition_example"; // string | The suggested default filename when downloading this object to a file after it has been uploaded.
$x_ads_region = "US"; // string | The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US`
$if_match = "if_match_example"; // string | If-Match header containing a SHA-1 hash of the bytes in the request body can be sent by the calling service or client application with the request. If present, OSS will use the value of If-Match header to verify that a SHA-1 calculated for the uploaded bytes server side matches what was sent in the header. If not, the request is failed with a status 412 Precondition Failed and the data is not written.
Expand Down Expand Up @@ -656,7 +656,7 @@ $apiInstance = new Autodesk\Forge\Client\Api\ObjectsApi($authObject);
$id = "id_example"; // string | Id of signed resource
$content_range = "content_range_example"; // string | Byte range of a segment being uploaded
$session_id = "session_id_example"; // string | Unique identifier of a session of a file being uploaded
$body = "/path/to/file.txt"; // \SplFileObject |
$body = file_get_contents("/path/to/file.txt"); // string | The content of the file to send
$content_disposition = "content_disposition_example"; // string | The suggested default filename when downloading this object to a file after it has been uploaded.
$x_ads_region = "US"; // string | The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US`

Expand Down
12 changes: 6 additions & 6 deletions lib/Api/ObjectsApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -1094,7 +1094,7 @@ public function getStatusBySessionIdWithHttpInfo($bucket_key, $object_name, $ses
* @param int $content_length Indicates the size of the request body. (required)
* @param string $content_range Byte range of a segment being uploaded (required)
* @param string $session_id Unique identifier of a session of a file being uploaded (required)
* @param \SplFileObject $body (required)
* @param string $body Chunk content (required)
* @param string $content_disposition The suggested default filename when downloading this object to a file after it has been uploaded. (optional)
* @param string $if_match If-Match header containing a SHA-1 hash of the bytes in the request body can be sent by the calling service or client application with the request. If present, OSS will use the value of If-Match header to verify that a SHA-1 calculated for the uploaded bytes server side matches what was sent in the header. If not, the request is failed with a status 412 Precondition Failed and the data is not written. (optional)
* @throws \Autodesk\Forge\Client\ApiException on non-2xx response
Expand All @@ -1116,7 +1116,7 @@ public function uploadChunk($bucket_key, $object_name, $content_length, $content
* @param int $content_length Indicates the size of the request body. (required)
* @param string $content_range Byte range of a segment being uploaded (required)
* @param string $session_id Unique identifier of a session of a file being uploaded (required)
* @param string $body Chunk content(required)
* @param string $body Chunk content (required)
* @param string $content_disposition The suggested default filename when downloading this object to a file after it has been uploaded. (optional)
* @param string $if_match If-Match header containing a SHA-1 hash of the bytes in the request body can be sent by the calling service or client application with the request. If present, OSS will use the value of If-Match header to verify that a SHA-1 calculated for the uploaded bytes server side matches what was sent in the header. If not, the request is failed with a status 412 Precondition Failed and the data is not written. (optional)
* @throws \Autodesk\Forge\Client\ApiException on non-2xx response
Expand Down Expand Up @@ -1411,7 +1411,7 @@ public function uploadObjectWithHttpInfo($bucket_key, $object_name, $content_len
*
* @param string $id Id of signed resource (required)
* @param int $content_length Indicates the size of the request body. (required)
* @param \SplFileObject $body (required)
* @param string $body File content (required)
* @param string $content_disposition The suggested default filename when downloading this object to a file after it has been uploaded. (optional)
* @param string $x_ads_region The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US` (optional, default to US)
* @param string $if_match If-Match header containing a SHA-1 hash of the bytes in the request body can be sent by the calling service or client application with the request. If present, OSS will use the value of If-Match header to verify that a SHA-1 calculated for the uploaded bytes server side matches what was sent in the header. If not, the request is failed with a status 412 Precondition Failed and the data is not written. (optional)
Expand All @@ -1431,7 +1431,7 @@ public function uploadSignedResource($id, $content_length, $body, $content_dispo
*
* @param string $id Id of signed resource (required)
* @param int $content_length Indicates the size of the request body. (required)
* @param \SplFileObject $body (required)
* @param string $body File content (required)
* @param string $content_disposition The suggested default filename when downloading this object to a file after it has been uploaded. (optional)
* @param string $x_ads_region The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US` (optional, default to US)
* @param string $if_match If-Match header containing a SHA-1 hash of the bytes in the request body can be sent by the calling service or client application with the request. If present, OSS will use the value of If-Match header to verify that a SHA-1 calculated for the uploaded bytes server side matches what was sent in the header. If not, the request is failed with a status 412 Precondition Failed and the data is not written. (optional)
Expand Down Expand Up @@ -1544,7 +1544,7 @@ public function uploadSignedResourceWithHttpInfo($id, $content_length, $body, $c
* @param string $id Id of signed resource (required)
* @param string $content_range Byte range of a segment being uploaded (required)
* @param string $session_id Unique identifier of a session of a file being uploaded (required)
* @param \SplFileObject $body (required)
* @param string $body File content (required)
* @param string $content_disposition The suggested default filename when downloading this object to a file after it has been uploaded. (optional)
* @param string $x_ads_region The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US` (optional, default to US)
* @throws \Autodesk\Forge\Client\ApiException on non-2xx response
Expand All @@ -1564,7 +1564,7 @@ public function uploadSignedResourcesChunk($id, $content_range, $session_id, $bo
* @param string $id Id of signed resource (required)
* @param string $content_range Byte range of a segment being uploaded (required)
* @param string $session_id Unique identifier of a session of a file being uploaded (required)
* @param \SplFileObject $body (required)
* @param string $body Chunk content (required)
* @param string $content_disposition The suggested default filename when downloading this object to a file after it has been uploaded. (optional)
* @param string $x_ads_region The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US` (optional, default to US)
* @throws \Autodesk\Forge\Client\ApiException on non-2xx response
Expand Down