Skip to content

Latest commit

 

History

History
494 lines (450 loc) · 41.2 KB

README.md

File metadata and controls

494 lines (450 loc) · 41.2 KB

Go API client for aptibleapi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: v1
  • Package version: 1.0.0
  • Generator version: 7.6.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import aptibleapi "github.com/aptible/aptible-api-go/aptibleapi"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value aptibleapi.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), aptibleapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value aptibleapi.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), aptibleapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using aptibleapi.ContextOperationServerIndices and aptibleapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), aptibleapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), aptibleapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.aptible.com

Class Method HTTP request Description
AccountsAPI CreateAccount Post /accounts create account
AccountsAPI DeleteAccount Delete /accounts/{id} delete account
AccountsAPI GetAccount Get /accounts/{id} show account
AccountsAPI ListAccounts Get /accounts list accounts
AccountsAPI ListAccountsForStack Get /stacks/{stack_id}/accounts list accounts
AccountsAPI PatchAccount Patch /accounts/{id} update account
AccountsAPI UpdateAccount Put /accounts/{id} update account
ActivityReportsAPI GetActivityReport Get /activity_reports/{id} show activity_report
ActivityReportsAPI GetActivityReportDownload Get /activity_reports/{activity_report_id}/download download activity_report
ActivityReportsAPI ListActivityReportsForAccount Get /accounts/{account_id}/activity_reports list activity_reports
AppsAPI CreateApp Post /accounts/{account_id}/apps create app
AppsAPI DeleteApp Delete /apps/{id} delete app
AppsAPI GetApp Get /apps/{id} show app
AppsAPI ListApps Get /apps list apps
AppsAPI ListAppsForAccount Get /accounts/{account_id}/apps list apps
AppsAPI ListAppsForCertificate Get /certificates/{certificate_id}/apps list apps
AppsAPI PatchApp Patch /apps/{id} update app
AppsAPI UpdateApp Put /apps/{id} update app
BackupRetentionPoliciesAPI CreateBackupRetentionPolicy Post /accounts/{account_id}/backup_retention_policies create backup retention policy
BackupRetentionPoliciesAPI GetBackupRetentionPolicy Get /backup_retention_policies/{id} show backup_retention_policy
BackupRetentionPoliciesAPI ListBackupRetentionPoliciesForAccount Get /accounts/{account_id}/backup_retention_policies list backup retention policies
BackupsAPI GetBackup Get /backups/{id} show backup
BackupsAPI ListBackups Get /backups list backups
BackupsAPI ListBackupsForAccount Get /accounts/{account_id}/backups list backups
BackupsAPI ListBackupsForDatabase Get /databases/{database_id}/backups list backups
BackupsAPI ListCopiesForBackup Get /backups/{backup_id}/copies list backups
CertificatesAPI CreateCertificate Post /accounts/{account_id}/certificates create certificate
CertificatesAPI DeleteCertificate Delete /certificates/{id} delete certificate
CertificatesAPI GetCertificate Get /certificates/{id} show certificate
CertificatesAPI ListCertificatesForAccount Get /accounts/{account_id}/certificates list certificates
CertificatesAPI PatchCertificate Patch /certificates/{id} update certificate
CertificatesAPI UpdateCertificate Put /certificates/{id} update certificate
ClaimsAPI ClaimsTypePost Post /claims/{type} create claim
ClaimsAPI CreateClaim Post /claims create claim
ClaimsAPI CreateClaimForAccount Post /accounts/{account_id}/claims/{type} create claim
CodeScanResultsAPI CreateCodeScanResult Post /apps/{app_id}/code_scan_results create code_scan_result
CodeScanResultsAPI DeleteCodeScanResult Delete /code_scan_results/{id} delete code_scan_result
CodeScanResultsAPI GetCodeScanResult Get /code_scan_results/{id} show code_scan_result
CodeScanResultsAPI ListCodeScanResultsForApp Get /apps/{app_id}/code_scan_results list code_scan_results
ConfigurationsAPI CreateConfigurationForApp Post /apps/{app_id}/configurations create configuration
ConfigurationsAPI CreateConfigurationForDatabase Post /databases/{database_id}/configurations create configuration
ConfigurationsAPI DeleteConfiguration Delete /configurations/{id} delete configuration
ConfigurationsAPI GetConfiguration Get /configurations/{id} show configuration
ConfigurationsAPI ListConfigurationsForApp Get /apps/{app_id}/configurations list configurations
ConfigurationsAPI ListConfigurationsForDatabase Get /databases/{database_id}/configurations list configurations
ContainersAPI GetContainer Get /containers/{id} show container
ContainersAPI ListContainersForRelease Get /releases/{release_id}/containers list containers
ContainersAPI LogDrainsLogDrainIdContainersGet Get /log_drains/{log_drain_id}/containers list containers
ContainersAPI MetricDrainsMetricDrainIdContainersGet Get /metric_drains/{metric_drain_id}/containers list containers
DatabaseCredentialsAPI GetDatabaseCredential Get /database_credentials/{id} show database_credential
DatabaseCredentialsAPI ListDatabaseCredentialsForDatabase Get /databases/{database_id}/database_credentials list database_credentials
DatabasesAPI CreateDatabase Post /accounts/{account_id}/databases create database
DatabasesAPI DeleteDatabase Delete /databases/{id} delete database
DatabasesAPI GetDatabase Get /databases/{id} show database
DatabasesAPI ListDatabases Get /databases list databases
DatabasesAPI ListDatabasesForAccount Get /accounts/{account_id}/databases list databases
DatabasesAPI ListReplicasForDatabase Get /databases/{database_id}/dependents list databases
DatabasesAPI PatchDatabase Patch /databases/{id} update database
DatabasesAPI UpdateDatabase Put /databases/{id} update database
DefaultAPI GetRoot Get / show home
DeploymentsAPI GetDeployment Get /deployments/{id} show deployment
DeploymentsAPI ListDeployments Get /deployments list deployments
DeploymentsAPI ListDeploymentsForApp Get /apps/{app_id}/deployments list deployments
DiskAttachmentsAPI GetDiskAttachment Get /disk_attachments/{id} show disk attachment
DiskAttachmentsAPI ListDiskAttachmentsForAccount Get /accounts/{account_id}/disk_attachments list disk attachments
DiskAttachmentsAPI ListDiskAttachmentsForPersistentDisk Get /persistent_disks/{persistent_disk_id}/disk_attachments list disk attachments
DiskAttachmentsAPI ListDiskAttachmentsForService Get /services/{service_id}/disk_attachments list disk attachments
DisksAPI GetDisk Get /disks/{id} show disk
DisksAPI ListDisksForAccount Get /accounts/{account_id}/disks list disks
EphemeralContainersAPI GetEphemeralContainer Get /ephemeral_containers/{id} show ephemeral_container
EphemeralContainersAPI ListEphemeralContainersForEphemeralSession Get /ephemeral_sessions/{ephemeral_session_id}/ephemeral_containers list ephemeral_containers
EphemeralContainersAPI ListEphemeralContainersForLogDrain Get /log_drains/{log_drain_id}/ephemeral_containers list ephemeral_containers
EphemeralSessionsAPI GetEphemeralSession Get /ephemeral_sessions/{id} show ephemeral_session
EphemeralSessionsAPI ListEphemeralSessionsForApp Get /apps/{app_id}/ephemeral_sessions list ephemeral_sessions
EphemeralSessionsAPI ListEphemeralSessionsForOperation Get /operations/{operation_id}/ephemeral_sessions list ephemeral_sessions
ImagesAPI GetDatabaseImage Get /database_images/{id} show database_image
ImagesAPI GetImage Get /images/{id} show image
ImagesAPI ListDatabaseImages Get /database_images list database_images
ImagesAPI ListImagesForApp Get /apps/{app_id}/images list images
IntrusionDetectionReportsAPI GetIntrustionDetectionReport Get /intrusion_detection_reports/{id} show intrusion_detection_report
IntrusionDetectionReportsAPI GetIntrustionDetectionReportCsvDownload Get /intrusion_detection_reports/{intrusion_report_id}/download_csv download_csv intrusion_detection_report
IntrusionDetectionReportsAPI GetIntrustionDetectionReportPdfDownload Get /intrusion_detection_reports/{intrusion_report_id}/download_pdf download_pdf intrusion_detection_report
IntrusionDetectionReportsAPI ListIntrustionDetectionReportsForStack Get /stacks/{stack_id}/intrusion_detection_reports list intrusion_detection_reports
LogDrainsAPI CreateLogDrain Post /accounts/{account_id}/log_drains create log_drain
LogDrainsAPI DeleteLogDrain Delete /log_drains/{id} delete log_drain
LogDrainsAPI GetLogDrain Get /log_drains/{id} show log_drain
LogDrainsAPI ListLogDrainsForAccount Get /accounts/{account_id}/log_drains list log_drains
LogDrainsAPI PatchLogDrain Patch /log_drains/{id} update log_drain
LogDrainsAPI UpdateLogDrain Put /log_drains/{id} update log_drain
MetricDrainsAPI CreateMetricDrain Post /accounts/{account_id}/metric_drains create metric_drain
MetricDrainsAPI GetMetricDrain Get /metric_drains/{id} show metric_drain
MetricDrainsAPI ListMetricDrainsForAccount Get /accounts/{account_id}/metric_drains list metric_drains
OperationsAPI CreateOperationForApp Post /apps/{app_id}/operations create operation
OperationsAPI CreateOperationForBackup Post /backups/{backup_id}/operations create operation
OperationsAPI CreateOperationForDatabase Post /databases/{database_id}/operations create operation
OperationsAPI CreateOperationForDatabaseCredential Post /database_credentials/{database_credential_id}/operations create operation
OperationsAPI CreateOperationForDiskAttachment Post /disk_attachments/{disk_attachment_id}/operations create operation
OperationsAPI CreateOperationForEphemeralSession Post /ephemeral_sessions/{ephemeral_session_id}/operations create operation
OperationsAPI CreateOperationForImage Post /images/{image_id}/operations create operation
OperationsAPI CreateOperationForLogDrain Post /log_drains/{log_drain_id}/operations create operation
OperationsAPI CreateOperationForMetricDrain Post /metric_drains/{metric_drain_id}/operations create operation
OperationsAPI CreateOperationForPersistentDisk Post /persistent_disks/{persistent_disk_id}/operations create operation
OperationsAPI CreateOperationForService Post /services/{service_id}/operations create operation
OperationsAPI CreateOperationForVhost Post /vhosts/{vhost_id}/operations create operation
OperationsAPI GetOperation Get /operations/{id} show operation
OperationsAPI ListOperationsForAccount Get /accounts/{account_id}/operations list operations
OperationsAPI ListOperationsForApp Get /apps/{app_id}/operations list operations
OperationsAPI ListOperationsForBackup Get /backups/{backup_id}/operations list operations
OperationsAPI ListOperationsForDatabase Get /databases/{database_id}/operations list operations
OperationsAPI ListOperationsForDatabaseCredential Get /database_credentials/{database_credential_id}/operations list operations
OperationsAPI ListOperationsForDiskAttachment Get /disk_attachments/{disk_attachment_id}/operations list operations
OperationsAPI ListOperationsForEphemeralSession Get /ephemeral_sessions/{ephemeral_session_id}/operations list operations
OperationsAPI ListOperationsForImage Get /images/{image_id}/operations list operations
OperationsAPI ListOperationsForLogDrain Get /log_drains/{log_drain_id}/operations list operations
OperationsAPI ListOperationsForMetricDrain Get /metric_drains/{metric_drain_id}/operations list operations
OperationsAPI ListOperationsForPersistentDisk Get /persistent_disks/{persistent_disk_id}/operations list operations
OperationsAPI ListOperationsForService Get /services/{service_id}/operations list operations
OperationsAPI ListOperationsForVhost Get /vhosts/{vhost_id}/operations list operations
OperationsAPI PatchOperation Patch /operations/{id} update operation
OperationsAPI UpdateOperation Put /operations/{id} update operation
PermissionsAPI CreatePermission Post /accounts/{account_id}/permissions create permission
PermissionsAPI DeletePermission Delete /permissions/{id} delete permission
PermissionsAPI GetPermission Get /permissions/{id} show permission
PermissionsAPI ListPermissions Get /permissions list permissions
PermissionsAPI ListPermissionsForAccount Get /accounts/{account_id}/permissions list permissions
PersistentDisksAPI GetPersistentDisk Get /persistent_disks/{id} show persistent disk
PersistentDisksAPI ListPersistentDisksForAccount Get /accounts/{account_id}/persistent_disks list persistent disks
PlansAPI GetPlan Get /plans/{id} show plan
PlansAPI ListPlans Get /plans list plans
ReleasesAPI GetRelease Get /releases/{id} show release
ReleasesAPI ListReleasesForService Get /services/{service_id}/releases list releases
ServiceSizingPoliciesAPI CreateServiceSizingPolicy Post /services/{service_id}/service_sizing_policies create service_sizing_policy
ServiceSizingPoliciesAPI DeleteServiceSizingPolicy Delete /services/{service_id}/service_sizing_policy delete service_sizing_policy
ServiceSizingPoliciesAPI GetServiceSizingPolicy Get /service_sizing_policies/{id} show service_sizing_policy
ServiceSizingPoliciesAPI ListServiceSizingPoliciesForAccount Get /accounts/{account_id}/service_sizing_policies list service_sizing_policies
ServiceSizingPoliciesAPI ListServiceSizingPoliciesForService Get /services/{service_id}/service_sizing_policies list service_sizing_policies
ServiceSizingPoliciesAPI UpdateServiceSizingPolicy Put /services/{service_id}/service_sizing_policies update service_sizing_policy
ServicesAPI GetService Get /services/{id} show service
ServicesAPI ListServicesForAccount Get /accounts/{account_id}/services list services
ServicesAPI ListServicesForApp Get /apps/{app_id}/services list services
ServicesAPI PatchService Patch /services/{id} update service
ServicesAPI UpdateService Put /services/{id} update service
SourcesAPI GetSource Get /sources/{id} show source
SourcesAPI ListAppsForSource Get /sources/{source_id}/apps list apps
SourcesAPI ListDeploymentsForSource Get /sources/{source_id}/deployments list deployments
SourcesAPI ListSources Get /sources list sources
SshPortalConnectionsAPI CreateSshPortalConnection Post /operations/{operation_id}/ssh_portal_connections create ssh_portal_connection
SshPortalConnectionsAPI GetSshPortalConnection Get /ssh_portal_connections/{id} show ssh_portal_connection
SshPortalConnectionsAPI ListSshPortalConnectionsForOperation Get /operations/{operation_id}/ssh_portal_connections list ssh_portal_connections
StacksAPI GetStack Get /stacks/{id} show stack
StacksAPI ListStacks Get /stacks list stacks
VhostsAPI CreateVhost Post /services/{service_id}/vhosts create vhost
VhostsAPI DeleteVhost Delete /vhosts/{id} delete vhost
VhostsAPI GetVhost Get /vhosts/{id} show vhost
VhostsAPI ListVhostsForAccount Get /accounts/{account_id}/vhosts list vhosts
VhostsAPI ListVhostsForApp Get /apps/{app_id}/vhosts list vhosts
VhostsAPI ListVhostsForCertificate Get /certificates/{certificate_id}/vhosts list vhosts
VhostsAPI ListVhostsForService Get /services/{service_id}/vhosts list vhosts
VhostsAPI PatchVhost Patch /vhosts/{id} update vhost
VhostsAPI UpdateVhost Put /vhosts/{id} update vhost
VpcPeersAPI GetVpcPeer Get /vpc_peers/{id} show vpc_peer
VpcPeersAPI ListVpcPeersForStack Get /stacks/{stack_id}/vpc_peers list vpc_peers
VpnTunnelsAPI GetVpnTunnel Get /vpn_tunnels/{id} show vpn_tunnel
VpnTunnelsAPI ListVpnTunnelsForStack Get /stacks/{stack_id}/vpn_tunnels list vpn_tunnels

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

token

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		aptibleapi.ContextAPIKeys,
		map[string]aptibleapi.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author