sysbot/quayio-api

Quay API

Go API client for client

This API allows you to perform many of the operations required to work with Quay repositories, users, and organizations. You can find out more at <a href="https://quay.io\">Quay.

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
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

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

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

import sw "./client"

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 sw.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), sw.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 identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to https://quay.io

Class	Method	HTTP request	Description
BillingApi	ListOrgInvoices	Get /api/v1/organization/{orgname}/invoices
BillingApi	ListPlans	Get /api/v1/plans/
BuildApi	CancelRepoBuild	Delete /api/v1/repository/{repository}/build/{build_uuid}
BuildApi	GetRepoBuild	Get /api/v1/repository/{repository}/build/{build_uuid}
BuildApi	GetRepoBuildLogs	Get /api/v1/repository/{repository}/build/{build_uuid}/logs
BuildApi	GetRepoBuildStatus	Get /api/v1/repository/{repository}/build/{build_uuid}/status
BuildApi	GetRepoBuilds	Get /api/v1/repository/{repository}/build/
BuildApi	RequestRepoBuild	Post /api/v1/repository/{repository}/build/
DiscoveryApi	Discovery	Get /api/v1/discovery
ErrorApi	GetErrorDescription	Get /api/v1/error/{error_type}
GlobalmessagesApi	CreateGlobalMessage	Post /api/v1/messages
GlobalmessagesApi	GetGlobalMessages	Get /api/v1/messages
ImageApi	GetImage	Get /api/v1/repository/{repository}/image/{image_id}
ImageApi	ListRepositoryImages	Get /api/v1/repository/{repository}/image/
LogsApi	ListOrgLogs	Get /api/v1/organization/{orgname}/logs
LogsApi	ListRepoLogs	Get /api/v1/repository/{repository}/logs
LogsApi	ListUserLogs	Get /api/v1/user/logs
ManifestApi	AddManifestLabel	Post /api/v1/repository/{repository}/manifest/{manifestref}/labels
ManifestApi	DeleteManifestLabel	Delete /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid}
ManifestApi	GetManifestLabel	Get /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid}
ManifestApi	GetRepoManifest	Get /api/v1/repository/{repository}/manifest/{manifestref}
ManifestApi	ListManifestLabels	Get /api/v1/repository/{repository}/manifest/{manifestref}/labels
OrganizationApi	ChangeOrganizationDetails	Put /api/v1/organization/{orgname}
OrganizationApi	CreateOrganization	Post /api/v1/organization/
OrganizationApi	CreateOrganizationApplication	Post /api/v1/organization/{orgname}/applications
OrganizationApi	DeleteAdminedOrganization	Delete /api/v1/organization/{orgname}
OrganizationApi	DeleteOrganizationApplication	Delete /api/v1/organization/{orgname}/applications/{client_id}
OrganizationApi	GetApplicationInformation	Get /api/v1/app/{client_id}
OrganizationApi	GetOrganization	Get /api/v1/organization/{orgname}
OrganizationApi	GetOrganizationApplication	Get /api/v1/organization/{orgname}/applications/{client_id}
OrganizationApi	GetOrganizationApplications	Get /api/v1/organization/{orgname}/applications
OrganizationApi	GetOrganizationCollaborators	Get /api/v1/organization/{orgname}/collaborators
OrganizationApi	GetOrganizationMember	Get /api/v1/organization/{orgname}/members/{membername}
OrganizationApi	GetOrganizationMembers	Get /api/v1/organization/{orgname}/members
OrganizationApi	RemoveOrganizationMember	Delete /api/v1/organization/{orgname}/members/{membername}
OrganizationApi	UpdateOrganizationApplication	Put /api/v1/organization/{orgname}/applications/{client_id}
PermissionApi	ChangeTeamPermissions	Put /api/v1/repository/{repository}/permissions/team/{teamname}
PermissionApi	ChangeUserPermissions	Put /api/v1/repository/{repository}/permissions/user/{username}
PermissionApi	DeleteTeamPermissions	Delete /api/v1/repository/{repository}/permissions/team/{teamname}
PermissionApi	DeleteUserPermissions	Delete /api/v1/repository/{repository}/permissions/user/{username}
PermissionApi	GetTeamPermissions	Get /api/v1/repository/{repository}/permissions/team/{teamname}
PermissionApi	GetUserPermissions	Get /api/v1/repository/{repository}/permissions/user/{username}
PermissionApi	GetUserTransitivePermission	Get /api/v1/repository/{repository}/permissions/user/{username}/transitive
PermissionApi	ListRepoTeamPermissions	Get /api/v1/repository/{repository}/permissions/team/
PermissionApi	ListRepoUserPermissions	Get /api/v1/repository/{repository}/permissions/user/
PrototypeApi	CreateOrganizationPrototypePermission	Post /api/v1/organization/{orgname}/prototypes
PrototypeApi	DeleteOrganizationPrototypePermission	Delete /api/v1/organization/{orgname}/prototypes/{prototypeid}
PrototypeApi	GetOrganizationPrototypePermissions	Get /api/v1/organization/{orgname}/prototypes
PrototypeApi	UpdateOrganizationPrototypePermission	Put /api/v1/organization/{orgname}/prototypes/{prototypeid}
RepositoryApi	ChangeRepoTrust	Post /api/v1/repository/{repository}/changetrust
RepositoryApi	ChangeRepoVisibility	Post /api/v1/repository/{repository}/changevisibility
RepositoryApi	CreateRepo	Post /api/v1/repository
RepositoryApi	DeleteRepository	Delete /api/v1/repository/{repository}
RepositoryApi	GetRepo	Get /api/v1/repository/{repository}
RepositoryApi	ListRepos	Get /api/v1/repository
RepositoryApi	UpdateRepo	Put /api/v1/repository/{repository}
RepositorynotificationApi	CreateRepoNotification	Post /api/v1/repository/{repository}/notification/
RepositorynotificationApi	DeleteRepoNotification	Delete /api/v1/repository/{repository}/notification/{uuid}
RepositorynotificationApi	GetRepoNotification	Get /api/v1/repository/{repository}/notification/{uuid}
RepositorynotificationApi	ListRepoNotifications	Get /api/v1/repository/{repository}/notification/
RepositorynotificationApi	ResetRepositoryNotificationFailures	Post /api/v1/repository/{repository}/notification/{uuid}
RepositorynotificationApi	TestRepoNotification	Post /api/v1/repository/{repository}/notification/{uuid}/test
RepotokenApi	ChangeToken	Put /api/v1/repository/{repository}/tokens/{code}
RepotokenApi	CreateToken	Post /api/v1/repository/{repository}/tokens/
RepotokenApi	DeleteToken	Delete /api/v1/repository/{repository}/tokens/{code}
RepotokenApi	GetTokens	Get /api/v1/repository/{repository}/tokens/{code}
RepotokenApi	ListRepoTokens	Get /api/v1/repository/{repository}/tokens/
RobotApi	CreateOrgRobot	Put /api/v1/organization/{orgname}/robots/{robot_shortname}
RobotApi	CreateUserRobot	Put /api/v1/user/robots/{robot_shortname}
RobotApi	DeleteOrgRobot	Delete /api/v1/organization/{orgname}/robots/{robot_shortname}
RobotApi	DeleteUserRobot	Delete /api/v1/user/robots/{robot_shortname}
RobotApi	GetOrgRobot	Get /api/v1/organization/{orgname}/robots/{robot_shortname}
RobotApi	GetOrgRobotPermissions	Get /api/v1/organization/{orgname}/robots/{robot_shortname}/permissions
RobotApi	GetOrgRobots	Get /api/v1/organization/{orgname}/robots
RobotApi	GetUserRobot	Get /api/v1/user/robots/{robot_shortname}
RobotApi	GetUserRobotPermissions	Get /api/v1/user/robots/{robot_shortname}/permissions
RobotApi	GetUserRobots	Get /api/v1/user/robots
RobotApi	RegenerateOrgRobotToken	Post /api/v1/organization/{orgname}/robots/{robot_shortname}/regenerate
RobotApi	RegenerateUserRobotToken	Post /api/v1/user/robots/{robot_shortname}/regenerate
SearchApi	ConductRepoSearch	Get /api/v1/find/repositories
SearchApi	ConductSearch	Get /api/v1/find/all
SearchApi	GetMatchingEntities	Get /api/v1/entities/{prefix}
SecscanApi	GetRepoImageSecurity	Get /api/v1/repository/{repository}/image/{imageid}/security
SecscanApi	GetRepoManifestSecurity	Get /api/v1/repository/{repository}/manifest/{manifestref}/security
SigningApi	GetRepoSignatures	Get /api/v1/repository/{repository}/signatures
TagApi	ChangeTag	Put /api/v1/repository/{repository}/tag/{tag}
TagApi	DeleteFullTag	Delete /api/v1/repository/{repository}/tag/{tag}
TagApi	ListRepoTags	Get /api/v1/repository/{repository}/tag/
TagApi	ListTagImages	Get /api/v1/repository/{repository}/tag/{tag}/images
TagApi	RestoreTag	Post /api/v1/repository/{repository}/tag/{tag}/restore
TeamApi	DeleteOrganizationTeam	Delete /api/v1/organization/{orgname}/team/{teamname}
TeamApi	DeleteOrganizationTeamMember	Delete /api/v1/organization/{orgname}/team/{teamname}/members/{membername}
TeamApi	DeleteTeamMemberEmailInvite	Delete /api/v1/organization/{orgname}/team/{teamname}/invite/{email}
TeamApi	GetOrganizationTeamMembers	Get /api/v1/organization/{orgname}/team/{teamname}/members
TeamApi	GetOrganizationTeamPermissions	Get /api/v1/organization/{orgname}/team/{teamname}/permissions
TeamApi	InviteTeamMemberEmail	Put /api/v1/organization/{orgname}/team/{teamname}/invite/{email}
TeamApi	UpdateOrganizationTeam	Put /api/v1/organization/{orgname}/team/{teamname}
TeamApi	UpdateOrganizationTeamMember	Put /api/v1/organization/{orgname}/team/{teamname}/members/{membername}
TriggerApi	ActivateBuildTrigger	Post /api/v1/repository/{repository}/trigger/{trigger_uuid}/activate
TriggerApi	DeleteBuildTrigger	Delete /api/v1/repository/{repository}/trigger/{trigger_uuid}
TriggerApi	GetBuildTrigger	Get /api/v1/repository/{repository}/trigger/{trigger_uuid}
TriggerApi	ListBuildTriggers	Get /api/v1/repository/{repository}/trigger/
TriggerApi	ListTriggerRecentBuilds	Get /api/v1/repository/{repository}/trigger/{trigger_uuid}/builds
TriggerApi	ManuallyStartBuildTrigger	Post /api/v1/repository/{repository}/trigger/{trigger_uuid}/start
TriggerApi	UpdateBuildTrigger	Put /api/v1/repository/{repository}/trigger/{trigger_uuid}
UserApi	CreateStar	Post /api/v1/user/starred
UserApi	DeleteStar	Delete /api/v1/user/starred/{repository}
UserApi	GetLoggedInUser	Get /api/v1/user/
UserApi	GetUserInformation	Get /api/v1/users/{username}
UserApi	ListStarredRepos	Get /api/v1/user/starred

Documentation For Models

• AddLabel
• ApiError
• ApiErrorDescription
• BuildTriggerActivateRequest
• ChangeRepoTrust
• ChangeVisibility
• CreateMessage
• CreateMessageMessage
• CreateRobot
• NewApp
• NewOrg
• NewPrototype
• NewPrototypeActivatingUser
• NewPrototypeDelegate
• NewRepo
• NewStarredRepository
• NewToken
• NewUser
• NotificationCreateRequest
• PrototypeUpdate
• RepoUpdate
• RepositoryBuildRequest
• RestoreTag
• RunParameters
• TeamDescription
• TeamPermission
• TokenPermission
• UpdateApp
• UpdateOrg
• UpdateTrigger
• UpdateUser
• UserPermission
• UserView

Documentation For Authorization

oauth2_implicit

• Type: OAuth
• Flow: implicit
• Authorization URL: https://quay.io/oauth/authorize
• Scopes:
• repo:write: This application will be able to view, push and pull to all repositories to which the granting user or robot account has write access
• repo:read: This application will be able to view and pull all repositories visible to the granting user or robot account
• repo:create: This application will be able to create repositories in to any namespaces that the granting user or robot account is allowed to create repositories
• repo:admin: This application will have administrator access to all repositories to which the granting user or robot account has access
• user:admin: This application will be able to administer your account including creating robots and granting them permissions to your repositories. You should have absolute trust in the requesting application before granting this permission.
• org:admin: This application will be able to administer your organizations including creating robots, creating teams, adjusting team membership, and changing billing settings. You should have absolute trust in the requesting application before granting this permission.
• user:read: This application will be able to read user information such as username and email address.

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
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

support@quay.io