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

feat: (experiment) set id and *at fields readOnly in OAS3 #166

Closed
wants to merge 3 commits into from
Closed
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
110 changes: 110 additions & 0 deletions api/openapi.yaml

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/AuthToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CreatedAt** | Pointer to **time.Time** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**Description** | Pointer to **string** | Available only for API keys | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**Project** | Pointer to [**AuthTokenProject**](AuthTokenProject.md) | | [optional]
**ReadOnly** | Pointer to **bool** | | [optional]
**Token** | Pointer to **string** | | [optional]
**UpdatedAt** | Pointer to **time.Time** | | [optional]
**UpdatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**User** | Pointer to [**AuthTokenUser**](AuthTokenUser.md) | | [optional]

## Methods
Expand Down
6 changes: 3 additions & 3 deletions docs/AuthTokenProject.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**BgpConfig** | Pointer to [**Href**](Href.md) | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**Customdata** | Pointer to **map[string]interface{}** | | [optional]
**Devices** | Pointer to [**[]Href**](Href.md) | | [optional]
**Href** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**Invitations** | Pointer to [**[]Href**](Href.md) | | [optional]
**MaxDevices** | Pointer to **map[string]interface{}** | | [optional]
**Members** | Pointer to [**[]Href**](Href.md) | | [optional]
Expand All @@ -19,7 +19,7 @@ Name | Type | Description | Notes
**Organization** | Pointer to [**Organization**](Organization.md) | | [optional]
**PaymentMethod** | Pointer to [**Href**](Href.md) | | [optional]
**SshKeys** | Pointer to [**[]Href**](Href.md) | | [optional]
**UpdatedAt** | Pointer to **time.Time** | | [optional]
**UpdatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**Volumes** | Pointer to [**[]Href**](Href.md) | | [optional]
**Type** | Pointer to [**ProjectType**](ProjectType.md) | | [optional]
**Tags** | Pointer to **[]string** | | [optional]
Expand Down
8 changes: 4 additions & 4 deletions docs/AuthTokenUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AvatarThumbUrl** | Pointer to **string** | | [optional]
**AvatarUrl** | Pointer to **string** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**Customdata** | Pointer to **map[string]interface{}** | | [optional]
**DefaultOrganizationId** | Pointer to **string** | | [optional]
**DefaultProjectId** | Pointer to **string** | | [optional]
Expand All @@ -16,16 +16,16 @@ Name | Type | Description | Notes
**FraudScore** | Pointer to **string** | | [optional]
**FullName** | Pointer to **string** | | [optional]
**Href** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**LastLoginAt** | Pointer to **time.Time** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**LastLoginAt** | Pointer to **time.Time** | | [optional] [readonly]
**LastName** | Pointer to **string** | | [optional]
**MaxOrganizations** | Pointer to **int32** | | [optional]
**MaxProjects** | Pointer to **int32** | | [optional]
**PhoneNumber** | Pointer to **string** | | [optional]
**ShortId** | Pointer to **string** | | [optional]
**Timezone** | Pointer to **string** | | [optional]
**TwoFactorAuth** | Pointer to **string** | | [optional]
**UpdatedAt** | Pointer to **time.Time** | | [optional]
**UpdatedAt** | Pointer to **time.Time** | | [optional] [readonly]

## Methods

Expand Down
6 changes: 3 additions & 3 deletions docs/Batch.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CreatedAt** | Pointer to **time.Time** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**Devices** | Pointer to [**[]Href**](Href.md) | | [optional]
**ErrorMessages** | Pointer to **[]string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**Project** | Pointer to [**Href**](Href.md) | | [optional]
**Quantity** | Pointer to **int32** | | [optional]
**State** | Pointer to **string** | | [optional]
**UpdatedAt** | Pointer to **time.Time** | | [optional]
**UpdatedAt** | Pointer to **time.Time** | | [optional] [readonly]

## Methods

Expand Down
6 changes: 3 additions & 3 deletions docs/BgpConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Asn** | Pointer to **int32** | Autonomous System Number. ASN is required with Global BGP. With Local BGP the private ASN, 65000, is assigned. | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**DeploymentType** | Pointer to [**BgpConfigDeploymentType**](BgpConfigDeploymentType.md) | | [optional]
**Href** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**MaxPrefix** | Pointer to **int32** | The maximum number of route filters allowed per server | [optional] [default to 10]
**Md5** | Pointer to **NullableString** | (Optional) Password for BGP session in plaintext (not a checksum) | [optional]
**Project** | Pointer to [**Href**](Href.md) | | [optional]
**Ranges** | Pointer to [**[]GlobalBgpRange**](GlobalBgpRange.md) | The IP block ranges associated to the ASN (Populated in Global BGP only) | [optional]
**RequestedAt** | Pointer to **time.Time** | | [optional]
**RequestedAt** | Pointer to **time.Time** | | [optional] [readonly]
**RouteObject** | Pointer to **string** | Specifies AS-MACRO (aka AS-SET) to use when building client route filters | [optional]
**Sessions** | Pointer to [**[]BgpSession**](BgpSession.md) | The direct connections between neighboring routers that want to exchange routing information. | [optional]
**Status** | Pointer to [**BgpConfigStatus**](BgpConfigStatus.md) | | [optional]
Expand Down
6 changes: 3 additions & 3 deletions docs/BgpSession.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AddressFamily** | [**BgpSessionAddressFamily**](BgpSessionAddressFamily.md) | |
**CreatedAt** | Pointer to **time.Time** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**DefaultRoute** | Pointer to **bool** | | [optional]
**Device** | Pointer to [**Href**](Href.md) | | [optional]
**Href** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**LearnedRoutes** | Pointer to **[]string** | | [optional]
**Status** | Pointer to [**BgpSessionStatus**](BgpSessionStatus.md) | | [optional]
**UpdatedAt** | Pointer to **time.Time** | | [optional]
**UpdatedAt** | Pointer to **time.Time** | | [optional] [readonly]

## Methods

Expand Down
2 changes: 1 addition & 1 deletion docs/BondPortData.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **string** | ID of the bonding port | [optional]
**Id** | Pointer to **string** | ID of the bonding port | [optional] [readonly]
**Name** | Pointer to **string** | Name of the port interface for the bond (\"bond0\") | [optional]

## Methods
Expand Down
6 changes: 3 additions & 3 deletions docs/Device.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**AlwaysPxe** | Pointer to **bool** | | [optional]
**BillingCycle** | Pointer to **string** | | [optional]
**BondingMode** | Pointer to **int32** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**CreatedBy** | Pointer to [**DeviceCreatedBy**](DeviceCreatedBy.md) | | [optional]
**Customdata** | Pointer to **map[string]interface{}** | | [optional] [default to {}]
**Description** | Pointer to **string** | | [optional]
Expand All @@ -16,7 +16,7 @@ Name | Type | Description | Notes
**HardwareReservation** | Pointer to [**HardwareReservation**](HardwareReservation.md) | | [optional]
**Hostname** | Pointer to **string** | | [optional]
**Href** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**ImageUrl** | Pointer to **string** | | [optional]
**IpAddresses** | Pointer to [**[]IPAssignment**](IPAssignment.md) | | [optional]
**IpxeScriptUrl** | Pointer to **string** | | [optional]
Expand All @@ -42,7 +42,7 @@ Name | Type | Description | Notes
**SwitchUuid** | Pointer to **string** | Switch short id. This can be used to determine if two devices are connected to the same switch, for example. | [optional]
**Tags** | Pointer to **[]string** | | [optional]
**TerminationTime** | Pointer to **time.Time** | When the device will be terminated. If you don't supply timezone info, the timestamp is assumed to be in UTC. This is commonly set in advance for ephemeral spot market instances but this field may also be set with on-demand and reservation instances to automatically delete the resource at a given time. The termination time can also be used to release a hardware reservation instance at a given time, keeping the reservation open for other uses. On a spot market device, the termination time will be set automatically when outbid. | [optional]
**UpdatedAt** | Pointer to **time.Time** | | [optional]
**UpdatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**User** | Pointer to **string** | | [optional]
**Userdata** | Pointer to **string** | | [optional]
**Volumes** | Pointer to [**[]Href**](Href.md) | | [optional]
Expand Down
6 changes: 3 additions & 3 deletions docs/DeviceCreatedBy.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AvatarThumbUrl** | Pointer to **string** | Avatar thumbnail URL of the User | [optional]
**CreatedAt** | Pointer to **time.Time** | When the user was created | [optional]
**CreatedAt** | Pointer to **time.Time** | When the user was created | [optional] [readonly]
**Email** | Pointer to **string** | Primary email address of the User | [optional]
**FirstName** | Pointer to **string** | First name of the User | [optional]
**FullName** | Pointer to **string** | Full name of the User | [optional]
**Href** | Pointer to **string** | API URL uniquely representing the User | [optional]
**Id** | **string** | ID of the User |
**Id** | **string** | ID of the User | [readonly]
**LastName** | Pointer to **string** | Last name of the User | [optional]
**ShortId** | **string** | Short ID of the User |
**UpdatedAt** | Pointer to **time.Time** | When the user details were last updated | [optional]
**UpdatedAt** | Pointer to **time.Time** | When the user details were last updated | [optional] [readonly]

## Methods

Expand Down
2 changes: 1 addition & 1 deletion docs/DeviceMetro.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Code** | Pointer to **string** | | [optional]
**Country** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**Name** | Pointer to **string** | | [optional]

## Methods
Expand Down
2 changes: 1 addition & 1 deletion docs/Email.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**Address** | Pointer to **string** | | [optional]
**Default** | Pointer to **bool** | | [optional]
**Href** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**Verified** | Pointer to **bool** | | [optional]

## Methods
Expand Down
2 changes: 1 addition & 1 deletion docs/Entitlement.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**Description** | Pointer to **string** | | [optional]
**FeatureAccess** | Pointer to **map[string]interface{}** | | [optional]
**Href** | Pointer to **string** | | [optional]
**Id** | **string** | |
**Id** | **string** | | [readonly]
**InstanceQuota** | Pointer to **map[string]interface{}** | | [optional]
**IpQuota** | Pointer to **map[string]interface{}** | | [optional]
**Name** | Pointer to **string** | | [optional]
Expand Down
4 changes: 2 additions & 2 deletions docs/Event.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Body** | Pointer to **string** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**Href** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**Interpolated** | Pointer to **string** | | [optional]
**Relationships** | Pointer to [**[]Href**](Href.md) | | [optional]
**State** | Pointer to **string** | | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/Facility.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**Address** | Pointer to [**Address**](Address.md) | | [optional]
**Code** | Pointer to **string** | | [optional]
**Features** | Pointer to [**[]FacilityFeaturesInner**](FacilityFeaturesInner.md) | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**IpRanges** | Pointer to **[]string** | IP ranges registered in facility. Can be used for GeoIP location | [optional]
**Metro** | Pointer to [**DeviceMetro**](DeviceMetro.md) | | [optional]
**Name** | Pointer to **string** | | [optional]
Expand Down
4 changes: 2 additions & 2 deletions docs/FindIPAddressById200Response.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ Name | Type | Description | Notes
**AddressFamily** | Pointer to **int32** | | [optional]
**AssignedTo** | Pointer to [**Href**](Href.md) | | [optional]
**Cidr** | Pointer to **int32** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**Enabled** | Pointer to **bool** | | [optional]
**Gateway** | Pointer to **string** | | [optional]
**GlobalIp** | Pointer to **bool** | | [optional]
**Href** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**Manageable** | Pointer to **bool** | | [optional]
**Management** | Pointer to **bool** | | [optional]
**Metro** | Pointer to [**Metro**](Metro.md) | | [optional]
Expand Down
6 changes: 3 additions & 3 deletions docs/FindMetalGatewayById200Response.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CreatedAt** | Pointer to **time.Time** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**CreatedBy** | Pointer to [**Href**](Href.md) | | [optional]
**Href** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**IpReservation** | Pointer to [**VrfIpReservation**](VrfIpReservation.md) | | [optional]
**Project** | Pointer to [**Project**](Project.md) | | [optional]
**State** | Pointer to [**MetalGatewayState**](MetalGatewayState.md) | | [optional]
**UpdatedAt** | Pointer to **time.Time** | | [optional]
**UpdatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**VirtualNetwork** | Pointer to [**VirtualNetwork**](VirtualNetwork.md) | | [optional]
**Vrf** | Pointer to [**Vrf**](Vrf.md) | | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/GlobalBgpRange.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AddressFamily** | Pointer to **int32** | | [optional]
**Href** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**Project** | Pointer to [**Href**](Href.md) | | [optional]
**Range** | Pointer to **string** | | [optional]

Expand Down
4 changes: 2 additions & 2 deletions docs/HardwareReservation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CreatedAt** | Pointer to **time.Time** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**CustomRate** | Pointer to **float32** | Amount that will be charged for every billing_cycle. | [optional]
**Device** | Pointer to [**Device**](Device.md) | | [optional]
**Facility** | Pointer to [**Facility**](Facility.md) | | [optional]
**Href** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**NeedOfService** | Pointer to **bool** | Whether this Device requires assistance from Equinix Metal. | [optional]
**Plan** | Pointer to [**Plan**](Plan.md) | | [optional]
**Project** | Pointer to [**Project**](Project.md) | | [optional]
Expand Down
4 changes: 2 additions & 2 deletions docs/IPAssignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ Name | Type | Description | Notes
**AddressFamily** | Pointer to **int32** | | [optional]
**AssignedTo** | Pointer to [**Href**](Href.md) | | [optional]
**Cidr** | Pointer to **int32** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**Enabled** | Pointer to **bool** | | [optional]
**Gateway** | Pointer to **string** | | [optional]
**GlobalIp** | Pointer to **bool** | | [optional]
**Href** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**Manageable** | Pointer to **bool** | | [optional]
**Management** | Pointer to **bool** | | [optional]
**Metro** | Pointer to [**IPAssignmentMetro**](IPAssignmentMetro.md) | | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/IPAssignmentMetro.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Code** | Pointer to **string** | | [optional]
**Country** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**Name** | Pointer to **string** | | [optional]

## Methods
Expand Down
4 changes: 2 additions & 2 deletions docs/IPReservation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ Name | Type | Description | Notes
**Available** | Pointer to **string** | | [optional]
**Bill** | Pointer to **bool** | | [optional]
**Cidr** | Pointer to **int32** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional]
**CreatedAt** | Pointer to **time.Time** | | [optional] [readonly]
**Customdata** | Pointer to **map[string]interface{}** | | [optional]
**Enabled** | Pointer to **bool** | | [optional]
**Details** | Pointer to **string** | | [optional]
**Facility** | Pointer to [**IPReservationFacility**](IPReservationFacility.md) | | [optional]
**Gateway** | Pointer to **string** | | [optional]
**GlobalIp** | Pointer to **bool** | | [optional]
**Href** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**Manageable** | Pointer to **bool** | | [optional]
**Management** | Pointer to **bool** | | [optional]
**MetalGateway** | Pointer to [**MetalGatewayLite**](MetalGatewayLite.md) | | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/IPReservationFacility.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**Address** | Pointer to [**Address**](Address.md) | | [optional]
**Code** | Pointer to **string** | | [optional]
**Features** | Pointer to [**[]FacilityFeaturesInner**](FacilityFeaturesInner.md) | | [optional]
**Id** | Pointer to **string** | | [optional]
**Id** | Pointer to **string** | | [optional] [readonly]
**IpRanges** | Pointer to **[]string** | IP ranges registered in facility. Can be used for GeoIP location | [optional]
**Metro** | Pointer to [**DeviceMetro**](DeviceMetro.md) | | [optional]
**Name** | Pointer to **string** | | [optional]
Expand Down
Loading