diff --git a/management/server/http/api/openapi.yml b/management/server/http/api/openapi.yml index 2b8d614f639..3a125bdd7e7 100644 --- a/management/server/http/api/openapi.yml +++ b/management/server/http/api/openapi.yml @@ -115,11 +115,11 @@ components: format: date-time example: 2023-05-05T09:00:35.477782Z auto_groups: - description: Groups to auto-assign to peers registered by this user + description: Group IDs to auto-assign to peers registered by this user type: array items: type: string - example: devs + example: ch8i4ug6lnn4g9hqv7m0 is_current: description: Is true if authenticated user is the same as this user type: boolean @@ -154,11 +154,11 @@ components: type: string example: admin auto_groups: - description: Groups to auto-assign to peers registered by this user + description: Group IDs to auto-assign to peers registered by this user type: array items: type: string - example: devs + example: ch8i4ug6lnn4g9hqv7m0 is_blocked: description: If set to true then user is blocked and can't use the system type: boolean @@ -183,11 +183,11 @@ components: type: string example: admin auto_groups: - description: Groups to auto-assign to peers registered by this user + description: Group IDs to auto-assign to peers registered by this user type: array items: type: string - example: devs + example: ch8i4ug6lnn4g9hqv7m0 is_service_user: description: Is true if this user is a service user type: boolean @@ -405,7 +405,7 @@ components: type: array items: type: string - example: "devs" + example: "ch8i4ug6lnn4g9hqv7m0" updated_at: description: Setup key last update date type: string @@ -460,7 +460,7 @@ components: type: array items: type: string - example: "devs" + example: "ch8i4ug6lnn4g9hqv7m0" usage_limit: description: A number of times this key can be used. The value of 0 indicates the unlimited usage. type: integer @@ -621,13 +621,13 @@ components: properties: sources: type: array - description: List of source groups + description: List of source group IDs items: type: string example: "ch8i4ug6lnn4g9hqv7m1" destinations: type: array - description: List of destination groups + description: List of destination group IDs items: type: string example: "ch8i4ug6lnn4g9hqv7m0" @@ -645,12 +645,12 @@ components: - type: object properties: sources: - description: Rule source groups + description: Rule source group IDs type: array items: $ref: '#/components/schemas/GroupMinimum' destinations: - description: Rule destination groups + description: Rule destination group IDs type: array items: $ref: '#/components/schemas/GroupMinimum' @@ -708,13 +708,13 @@ components: - type: object properties: sources: - description: Policy rule source groups + description: Policy rule source group IDs type: array items: type: string example: "ch8i4ug6lnn4g9hqv797" destinations: - description: Policy rule destination groups + description: Policy rule destination group IDs type: array items: type: string @@ -728,12 +728,12 @@ components: - type: object properties: sources: - description: Policy rule source groups + description: Policy rule source group IDs type: array items: $ref: '#/components/schemas/GroupMinimum' destinations: - description: Policy rule destination groups + description: Policy rule destination group IDs type: array items: $ref: '#/components/schemas/GroupMinimum' @@ -834,7 +834,7 @@ components: type: boolean example: true groups: - description: Route group tag groups + description: Group IDs containing routing peers type: array items: type: string @@ -891,17 +891,17 @@ components: type: object properties: name: - description: Nameserver group name + description: Name of nameserver group name type: string maxLength: 40 minLength: 1 example: Google DNS description: - description: Nameserver group description + description: Description of the nameserver group type: string example: Google DNS servers nameservers: - description: Nameserver group + description: Nameserver list minLength: 1 maxLength: 2 type: array @@ -912,17 +912,17 @@ components: type: boolean example: true groups: - description: Nameserver group tag groups + description: Distribution group IDs that defines group of peers that will use this nameserver group type: array items: type: string example: ch8i4ug6lnn4g9hqv7m0 primary: - description: Nameserver group primary status + description: Defines if a nameserver group is primary that resolves all domains. It should be true only if domains list is empty. type: boolean example: true domains: - description: Nameserver group match domain list + description: Match domain list. It should be empty only if primary is true. type: array items: type: string @@ -930,7 +930,7 @@ components: maxLength: 255 example: "example.com" search_domains_enabled: - description: Nameserver group search domain status for match domains. It should be true only if domains list is not empty. + description: Search domain status for match domains. It should be true only if domains list is not empty. type: boolean example: true required: diff --git a/management/server/http/api/types.gen.go b/management/server/http/api/types.gen.go index 8e41f567249..820cf5c48b2 100644 --- a/management/server/http/api/types.gen.go +++ b/management/server/http/api/types.gen.go @@ -271,58 +271,58 @@ type NameserverNsType string // NameserverGroup defines model for NameserverGroup. type NameserverGroup struct { - // Description Nameserver group description + // Description Description of the nameserver group Description string `json:"description"` - // Domains Nameserver group match domain list + // Domains Match domain list. It should be empty only if primary is true. Domains []string `json:"domains"` // Enabled Nameserver group status Enabled bool `json:"enabled"` - // Groups Nameserver group tag groups + // Groups Distribution group IDs that defines group of peers that will use this nameserver group Groups []string `json:"groups"` // Id Nameserver group ID Id string `json:"id"` - // Name Nameserver group name + // Name Name of nameserver group name Name string `json:"name"` - // Nameservers Nameserver group + // Nameservers Nameserver list Nameservers []Nameserver `json:"nameservers"` - // Primary Nameserver group primary status + // Primary Defines if a nameserver group is primary that resolves all domains. It should be true only if domains list is empty. Primary bool `json:"primary"` - // SearchDomainsEnabled Nameserver group search domain status for match domains. It should be true only if domains list is not empty. + // SearchDomainsEnabled Search domain status for match domains. It should be true only if domains list is not empty. SearchDomainsEnabled bool `json:"search_domains_enabled"` } // NameserverGroupRequest defines model for NameserverGroupRequest. type NameserverGroupRequest struct { - // Description Nameserver group description + // Description Description of the nameserver group Description string `json:"description"` - // Domains Nameserver group match domain list + // Domains Match domain list. It should be empty only if primary is true. Domains []string `json:"domains"` // Enabled Nameserver group status Enabled bool `json:"enabled"` - // Groups Nameserver group tag groups + // Groups Distribution group IDs that defines group of peers that will use this nameserver group Groups []string `json:"groups"` - // Name Nameserver group name + // Name Name of nameserver group name Name string `json:"name"` - // Nameservers Nameserver group + // Nameservers Nameserver list Nameservers []Nameserver `json:"nameservers"` - // Primary Nameserver group primary status + // Primary Defines if a nameserver group is primary that resolves all domains. It should be true only if domains list is empty. Primary bool `json:"primary"` - // SearchDomainsEnabled Nameserver group search domain status for match domains. It should be true only if domains list is not empty. + // SearchDomainsEnabled Search domain status for match domains. It should be true only if domains list is not empty. SearchDomainsEnabled bool `json:"search_domains_enabled"` } @@ -600,7 +600,7 @@ type PolicyRule struct { // Description Policy rule friendly description Description *string `json:"description,omitempty"` - // Destinations Policy rule destination groups + // Destinations Policy rule destination group IDs Destinations []GroupMinimum `json:"destinations"` // Enabled Policy rule status @@ -618,7 +618,7 @@ type PolicyRule struct { // Protocol Policy rule type of the traffic Protocol PolicyRuleProtocol `json:"protocol"` - // Sources Policy rule source groups + // Sources Policy rule source group IDs Sources []GroupMinimum `json:"sources"` } @@ -672,7 +672,7 @@ type PolicyRuleUpdate struct { // Description Policy rule friendly description Description *string `json:"description,omitempty"` - // Destinations Policy rule destination groups + // Destinations Policy rule destination group IDs Destinations []string `json:"destinations"` // Enabled Policy rule status @@ -690,7 +690,7 @@ type PolicyRuleUpdate struct { // Protocol Policy rule type of the traffic Protocol PolicyRuleUpdateProtocol `json:"protocol"` - // Sources Policy rule source groups + // Sources Policy rule source group IDs Sources []string `json:"sources"` } @@ -729,7 +729,7 @@ type Route struct { // Enabled Route status Enabled bool `json:"enabled"` - // Groups Route group tag groups + // Groups Group IDs containing routing peers Groups []string `json:"groups"` // Id Route Id @@ -765,7 +765,7 @@ type RouteRequest struct { // Enabled Route status Enabled bool `json:"enabled"` - // Groups Route group tag groups + // Groups Group IDs containing routing peers Groups []string `json:"groups"` // Masquerade Indicate if peer should masquerade traffic to this route's prefix @@ -792,7 +792,7 @@ type Rule struct { // Description Rule friendly description Description string `json:"description"` - // Destinations Rule destination groups + // Destinations Rule destination group IDs Destinations []GroupMinimum `json:"destinations"` // Disabled Rules status @@ -807,7 +807,7 @@ type Rule struct { // Name Rule name identifier Name string `json:"name"` - // Sources Rule source groups + // Sources Rule source group IDs Sources []GroupMinimum `json:"sources"` } @@ -831,7 +831,7 @@ type RuleRequest struct { // Description Rule friendly description Description string `json:"description"` - // Destinations List of destination groups + // Destinations List of destination group IDs Destinations *[]string `json:"destinations,omitempty"` // Disabled Rules status @@ -843,7 +843,7 @@ type RuleRequest struct { // Name Rule name identifier Name string `json:"name"` - // Sources List of source groups + // Sources List of source group IDs Sources *[]string `json:"sources,omitempty"` } @@ -918,7 +918,7 @@ type SetupKeyRequest struct { // User defines model for User. type User struct { - // AutoGroups Groups to auto-assign to peers registered by this user + // AutoGroups Group IDs to auto-assign to peers registered by this user AutoGroups []string `json:"auto_groups"` // Email User's email address @@ -957,7 +957,7 @@ type UserStatus string // UserCreateRequest defines model for UserCreateRequest. type UserCreateRequest struct { - // AutoGroups Groups to auto-assign to peers registered by this user + // AutoGroups Group IDs to auto-assign to peers registered by this user AutoGroups []string `json:"auto_groups"` // Email User's Email to send invite to @@ -975,7 +975,7 @@ type UserCreateRequest struct { // UserRequest defines model for UserRequest. type UserRequest struct { - // AutoGroups Groups to auto-assign to peers registered by this user + // AutoGroups Group IDs to auto-assign to peers registered by this user AutoGroups []string `json:"auto_groups"` // IsBlocked If set to true then user is blocked and can't use the system