Skip to content

Commit

Permalink
Add json tags to clientconfig's structs (gophercloud#75)
Browse files Browse the repository at this point in the history
* Add json tags to clientconfig's structs

Some yaml libraries use json tags to drive serialization for both, json
and yaml. This patch adds json tags to the clientconfig's structs to
support those libraries.

The lack of these tags has caused some integration issues with other
softare using packages like `ghodss/yaml`. An example of this can be
found in the PR linked below:

openshift/installer#854

* Make format happy
  • Loading branch information
flaper87 authored and jtopjian committed Jan 24, 2019
1 parent a5c25e7 commit 9c3b9f2
Showing 1 changed file with 28 additions and 28 deletions.
56 changes: 28 additions & 28 deletions openstack/clientconfig/results.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,62 +4,62 @@ package clientconfig
// The format of the clouds-public.yml is documented at
// https://docs.openstack.org/python-openstackclient/latest/configuration/
type PublicClouds struct {
Clouds map[string]Cloud `yaml:"public-clouds"`
Clouds map[string]Cloud `yaml:"public-clouds" json:"public-clouds"`
}

// Clouds represents a collection of Cloud entries in a clouds.yaml file.
// The format of clouds.yaml is documented at
// https://docs.openstack.org/os-client-config/latest/user/configuration.html.
type Clouds struct {
Clouds map[string]Cloud `yaml:"clouds"`
Clouds map[string]Cloud `yaml:"clouds" json:"clouds"`
}

// Cloud represents an entry in a clouds.yaml/public-clouds.yaml/secure.yaml file.
type Cloud struct {
Cloud string `yaml:"cloud"`
Profile string `yaml:"profile"`
AuthInfo *AuthInfo `yaml:"auth"`
AuthType AuthType `yaml:"auth_type"`
RegionName string `yaml:"region_name"`
Regions []interface{} `yaml:"regions"`
Cloud string `yaml:"cloud" json:"cloud"`
Profile string `yaml:"profile" json:"profile"`
AuthInfo *AuthInfo `yaml:"auth" json:"auth"`
AuthType AuthType `yaml:"auth_type" json:"auth_type"`
RegionName string `yaml:"region_name" json:"region_name"`
Regions []interface{} `yaml:"regions" json:"regions"`

// API Version overrides.
IdentityAPIVersion string `yaml:"identity_api_version"`
VolumeAPIVersion string `yaml:"volume_api_version"`
IdentityAPIVersion string `yaml:"identity_api_version" json:"identity_api_version"`
VolumeAPIVersion string `yaml:"volume_api_version" json:"volume_api_version"`

// Verify whether or not SSL API requests should be verified.
Verify *bool `yaml:"verify"`
Verify *bool `yaml:"verify" json:"verify"`

// CACertFile a path to a CA Cert bundle that can be used as part of
// verifying SSL API requests.
CACertFile string `yaml:"cacert"`
CACertFile string `yaml:"cacert" json:"cacert"`

// ClientCertFile a path to a client certificate to use as part of the SSL
// transaction.
ClientCertFile string `yaml:"cert"`
ClientCertFile string `yaml:"cert" json:"cert"`

// ClientKeyFile a path to a client key to use as part of the SSL
// transaction.
ClientKeyFile string `yaml:"key"`
ClientKeyFile string `yaml:"key" json:"key"`
}

// AuthInfo represents the auth section of a cloud entry or
// auth options entered explicitly in ClientOpts.
type AuthInfo struct {
// AuthURL is the keystone/identity endpoint URL.
AuthURL string `yaml:"auth_url"`
AuthURL string `yaml:"auth_url" json:"auth_url"`

// Token is a pre-generated authentication token.
Token string `yaml:"token"`
Token string `yaml:"token" json:"token"`

// Username is the username of the user.
Username string `yaml:"username"`
Username string `yaml:"username" json:"username"`

// UserID is the unique ID of a user.
UserID string `yaml:"user_id"`
UserID string `yaml:"user_id" json:"user_id"`

// Password is the password of the user.
Password string `yaml:"password"`
Password string `yaml:"password" json:"password"`

// Application Credential ID to login with.
ApplicationCredentialID string `yaml:"application_credential_id"`
Expand All @@ -75,47 +75,47 @@ type AuthInfo struct {
// ProjectName on its own is not enough to ensure a unique scope. It must
// also be combined with either a ProjectDomainName or ProjectDomainID.
// ProjectName cannot be combined with ProjectID in a scope.
ProjectName string `yaml:"project_name"`
ProjectName string `yaml:"project_name" json:"project_name"`

// ProjectID is the unique ID of a project.
// It can be used to scope a user to a specific project.
ProjectID string `yaml:"project_id"`
ProjectID string `yaml:"project_id" json:"project_id"`

// UserDomainName is the name of the domain where a user resides.
// It is used to identify the source domain of a user.
UserDomainName string `yaml:"user_domain_name"`
UserDomainName string `yaml:"user_domain_name" json:"user_domain_name"`

// UserDomainID is the unique ID of the domain where a user resides.
// It is used to identify the source domain of a user.
UserDomainID string `yaml:"user_domain_id"`
UserDomainID string `yaml:"user_domain_id" json:"user_domain_id"`

// ProjectDomainName is the name of the domain where a project resides.
// It is used to identify the source domain of a project.
// ProjectDomainName can be used in addition to a ProjectName when scoping
// a user to a specific project.
ProjectDomainName string `yaml:"project_domain_name"`
ProjectDomainName string `yaml:"project_domain_name" json:"project_domain_name"`

// ProjectDomainID is the name of the domain where a project resides.
// It is used to identify the source domain of a project.
// ProjectDomainID can be used in addition to a ProjectName when scoping
// a user to a specific project.
ProjectDomainID string `yaml:"project_domain_id"`
ProjectDomainID string `yaml:"project_domain_id" json:"project_domain_id"`

// DomainName is the name of a domain which can be used to identify the
// source domain of either a user or a project.
// If UserDomainName and ProjectDomainName are not specified, then DomainName
// is used as a default choice.
// It can also be used be used to specify a domain-only scope.
DomainName string `yaml:"domain_name"`
DomainName string `yaml:"domain_name" json:"domain_name"`

// DomainID is the unique ID of a domain which can be used to identify the
// source domain of eitehr a user or a project.
// If UserDomainID and ProjectDomainID are not specified, then DomainID is
// used as a default choice.
// It can also be used be used to specify a domain-only scope.
DomainID string `yaml:"domain_id"`
DomainID string `yaml:"domain_id" json:"domain_id"`

// DefaultDomain is the domain ID to fall back on if no other domain has
// been specified and a domain is required for scope.
DefaultDomain string `yaml:"default_domain"`
DefaultDomain string `yaml:"default_domain" json:"default_domain"`
}

0 comments on commit 9c3b9f2

Please sign in to comment.