Skip to content

Commit

Permalink
osc-sdk-go v2.12.0
Browse files Browse the repository at this point in the history
Signed-off-by: Outscale Bot <[email protected]>
  • Loading branch information
Open-Source-Bot authored and jerome-jutteau committed Sep 27, 2022
1 parent 93ed198 commit 0d28741
Show file tree
Hide file tree
Showing 559 changed files with 1,180 additions and 1,170 deletions.
2 changes: 1 addition & 1 deletion api_version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.21.0
1.22.0
4 changes: 4 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# 2.12.0

- SDK update for Outscale API v1.22.0

# 2.11.0

- SDK update for Outscale API v1.21.0
Expand Down
2 changes: 1 addition & 1 deletion sdk_version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.11.0
2.12.0
7 changes: 4 additions & 3 deletions v2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@ Welcome to the OUTSCALE API documentation.<br />
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.<br /><br />
You can learn more about errors returned by the API in the dedicated [errors page](api/errors).<br /><br />
Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.<br />
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.<br /><br />
An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).

## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

- API version: 1.21
- Package version: 2.11.0
- API version: 1.22
- Package version: 2.12.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen

## Installation
Expand Down
95 changes: 50 additions & 45 deletions v2/api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,14 @@ info:
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.<br /><br />
You can learn more about errors returned by the API in the dedicated [errors page](api/errors).<br /><br />
Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html) between AWS and the OUTSCALE API.<br />
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.
You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.<br /><br />
An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).
license:
name: BSD 3 Clause
url: https://opensource.org/licenses/BSD-3-Clause
termsOfService: https://en.outscale.com/terms-of-service/
title: 3DS OUTSCALE API
version: "1.21"
version: "1.22"
servers:
- url: https://api.{region}.outscale.com/api/v1
variables:
Expand Down Expand Up @@ -983,15 +984,11 @@ paths:
- ServerCertificate
/CreateSnapshot:
description: |-
Creates a snapshot of a Block storage Unit (BSU) volume.<br />
Snapshots are point-in-time images of a volume you can use to back up your data or to create replicas of this volume at the time the snapshot was created.<br /><br />

You can also use this method to copy a snapshot to your account, from an account in the same Region.<br />
To do so, the owner of the source snapshot must share it with your account. For more information about how to share a snapshot with another account, see [UpdateSnapshot](#updatesnapshot).<br />
The copy of the source snapshot is independent and belongs to you.<br /><br />

To copy a snapshot between accounts in different Regions, the owner of the source snapshot must export it to an OUTSCALE Object Storage (OOS) bucket using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. You then need to import it from the bucket to create a copy of this snapshot in your account.<br />
You can import a snapshot using a pre-signed URL. You do not need any permission for this snapshot, or the bucket in which it is contained. The pre-signed URL is valid for seven days (you can regenerate a new one if needed).
Creates a snapshot. Snapshots are point-in-time images of a volume that you can use to back up your data or to create replicas of this volume.<br />
You can use this method in three different ways:
* **Creating**: You create a snapshot from one of your volumes.<br></li>
* **Copying**: You copy an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.<br></li>
* **Importing**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to the bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you read permission on the bucket via a pre-signed URL or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).
post:
operationId: CreateSnapshot
requestBody:
Expand Down Expand Up @@ -1050,8 +1047,7 @@ paths:
/CreateSubnet:
description: |-
Creates a Subnet in an existing Net.<br />
To create a Subnet in a Net, you have to provide the ID of the Net and the IP range for the Subnet (its network range). Once the Subnet is created, you cannot modify its IP range.<br />
The IP range of the Subnet can be either the same as the Net one if you create only a single Subnet in this Net, or a subset of the Net one. In case of several Subnets in a Net, their IP ranges must not overlap. The smallest Subnet you can create uses a /30 netmask (four IPs).
To create a Subnet in a Net, you have to provide the ID of the Net and the IP range for the Subnet (its network range). Once the Subnet is created, you cannot modify its IP range.
post:
operationId: CreateSubnet
requestBody:
Expand Down Expand Up @@ -5636,8 +5632,9 @@ components:
$ref: '#/components/schemas/BsuToCreate'
DeviceName:
description: The device name for the volume. For a root device, you must
use `/dev/sda1`. For other volumes, you must use `/dev/sdX` or `/dev/xvdX`
(where `X` is a letter between `b` and `z`).
use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXY`,
`/dev/xvdX`, or `/dev/xvdXY` (where `X` is a letter between `b` and `z`
and where `Y` is a letter between `a` and `z`).
type: string
VirtualDeviceName:
description: The name of the virtual device (`ephemeralN`).
Expand All @@ -5661,8 +5658,9 @@ components:
$ref: '#/components/schemas/BsuToCreate'
DeviceName:
description: The device name for the volume. For a root device, you must
use `/dev/sda1`. For other volumes, you must use `/dev/sdX` or `/dev/xvdX`
(where `X` is a letter between `b` and `z`).
use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXY`,
`/dev/xvdX`, or `/dev/xvdXY` (where `X` is a letter between `b` and `z`
and where `Y` is a letter between `a` and `z`).
type: string
NoDevice:
description: Removes the device which is included in the block device mapping
Expand All @@ -5687,8 +5685,9 @@ components:
$ref: '#/components/schemas/BsuToUpdateVm'
DeviceName:
description: The device name for the volume. For a root device, you must
use `/dev/sda1`. For other volumes, you must use `/dev/sdX` or `/dev/xvdX`
(where `X` is a letter between `b` and `z`).
use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXY`,
`/dev/xvdX`, or `/dev/xvdXY` (where `X` is a letter between `b` and `z`
and where `Y` is a letter between `a` and `z`).
type: string
NoDevice:
description: Removes the device which is included in the block device mapping
Expand Down Expand Up @@ -8211,24 +8210,27 @@ components:
perform the action.
type: boolean
FileLocation:
description: The pre-signed URL of the snapshot you want to import from
the bucket.
description: (When importing) The pre-signed URL of the snapshot you want
to import, or the normal URL of the snapshot if you have permission on
the OOS bucket. For more information, see [Configuring a Pre-signed URL](https://docs.outscale.com/en/userguide/Configuring-a-Pre-signed-URL.html)
or [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).
type: string
SnapshotSize:
description: The size of the snapshot you want to create in your account,
in bytes. This size must be greater than or equal to the size of the original,
uncompressed snapshot.
description: (When importing) The size of the snapshot you want to create
in your account, in bytes. This size must be greater than or equal to
the size of the original, uncompressed snapshot.
format: int64
type: integer
SourceRegionName:
description: The name of the source Region, which must be the same as the
Region of your account.
description: (When copying) The name of the source Region, which must be
the same as the Region of your account.
type: string
SourceSnapshotId:
description: The ID of the snapshot you want to copy.
description: (When copying) The ID of the snapshot you want to copy.
type: string
VolumeId:
description: The ID of the volume you want to create a snapshot of.
description: (When creating) The ID of the volume you want to create a snapshot
of.
type: string
type: object
CreateSnapshotResponse:
Expand Down Expand Up @@ -8275,8 +8277,9 @@ components:
perform the action.
type: boolean
IpRange:
description: The IP range in the Subnet, in CIDR notation (for example,
`10.0.0.0/16`).
description: |-
The IP range in the Subnet, in CIDR notation (for example, `10.0.0.0/16`).<br />
The IP range of the Subnet can be either the same as the Net one if you create only a single Subnet in this Net, or a subset of the Net one. In case of several Subnets in a Net, their IP ranges must not overlap. The smallest Subnet you can create uses a /29 netmask (eight IPs). For more information, see [About VPCs](https://docs.outscale.com/en/userguide/About-VPCs.html).
type: string
NetId:
description: The ID of the Net for which you want to create a Subnet.
Expand Down Expand Up @@ -12171,8 +12174,7 @@ components:
type: string
type: array
RouteStates:
description: The states of routes in the route tables (`active` \| `blackhole`).
The `blackhole` state indicates that the target of the route is not available.
description: The states of routes in the route tables (always `active`).
items:
type: string
type: array
Expand Down Expand Up @@ -13930,7 +13932,10 @@ components:
DeviceName: DeviceName
properties:
DeviceName:
description: The name of the device.
description: The name of the device. For a root device, you must use `/dev/sda1`.
For other volumes, you must use `/dev/sdX`, `/dev/sdXY`, `/dev/xvdX`,
or `/dev/xvdXY` (where `X` is a letter between `b` and `z` and where `Y`
is a letter between `a` and `z`).
type: string
DryRun:
description: If true, checks whether you have the required permissions to
Expand Down Expand Up @@ -15908,7 +15913,7 @@ components:
ReadConsumptionAccountRequest:
additionalProperties: false
example:
Overall: true
Overall: false
DryRun: true
FromDate: FromDate
ToDate: ToDate
Expand All @@ -15923,12 +15928,12 @@ components:
format: datetime
type: string
Overall:
default: true
description: By default or if true, returns either the overall consumption
of your paying account and all linked accounts (if the account that sends
this request is a paying account) or returns nothing (if the account that
sends this request is a linked account). If false, returns only the consumption
of the specific account that sends this request.
default: false
description: By default or if false, returns only the consumption of the
specific account that sends this request. If true, returns either the
overall consumption of your paying account and all linked accounts (if
the account that sends this request is a paying account) or returns nothing
(if the account that sends this request is a linked account).
type: boolean
ToDate:
description: The end of the time period, in ISO 8601 date-time format (for
Expand Down Expand Up @@ -19667,8 +19672,7 @@ components:
description: The ID of the NIC.
type: string
State:
description: The state of a route in the route table (`active` \| `blackhole`).
The `blackhole` state indicates that the target of the route is not available.
description: 'The state of a route in the route table (always `active`). '
type: string
VmAccountId:
description: The account ID of the owner of the VM.
Expand Down Expand Up @@ -20958,7 +20962,7 @@ components:
example:
DryRun: true
DirectLinkInterfaceId: DirectLinkInterfaceId
Mtu: 2100
Mtu: 0
properties:
DirectLinkInterfaceId:
description: The ID of the DirectLink interface you want to update.
Expand All @@ -20970,8 +20974,9 @@ components:
Mtu:
description: The maximum transmission unit (MTU) of the DirectLink interface,
in bytes (either `1500` or `9000`).
maximum: 9001
minimum: 1500
enum:
- 1500
- 9000
type: integer
required:
- DirectLinkInterfaceId
Expand Down
4 changes: 2 additions & 2 deletions v2/api_access_key.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions v2/api_account.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions v2/api_api_access_policy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 0d28741

Please sign in to comment.