Skip to content

Add GET /object-storage/transfer/ #353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 2, 2020
Merged
Changes from 1 commit
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
40 changes: 40 additions & 0 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11850,6 +11850,46 @@ paths:
source: >
linode-cli object-storage ssl-delete \
us-east-1 example-bucket
/object-storage/transfer:
get:
operationId: getObjectStorageTransfer
x-linode-cli-skip: true
servers:
- url: https://api.linode.com/v4
summary: Object Storage Transfer View
description: |
The amount of outbound data transfer used by your account's Object Storage buckets.
Object Storage adds 1 terabyte of outbound data transfer to your data transfer pool.
See the [Object Storage Pricing and Limitations](/docs/guides/pricing-and-limitations/)
guide for details on Object Storage transfer quotas.

tags:
- Object Storage
security:
- personalAccessToken: []
- oauth:
- object_storage:read_write
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be object_storage:read_only

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated!

responses:
'200':
description: A paginated list of buckets you own.
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this need to have a description? The transfer description below should suffice. This endpoint is also not paginated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Our theme requires a description here. I've updated the description copy.

content:
application/json:
schema:
properties:
used:
type: integer
description: >
The amount of outbound data transfer used by your account's Object Storage buckets,
in GB, for the current month’s billing cycle.
example: 12956600198
readOnly: true
default:
$ref: '#/components/responses/ErrorResponse'
x-code-samples:
- lang: Shell
source: >
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/object-storage/transfer/
/profile:
x-linode-cli-command: profile
get:
Expand Down