Project: Gloo (Orchestration & Management / API Gateway)
File: gloo_validation.proto.sk.md

title: "gloo_validation.proto" weight: 5 <!-- Code generated by solo-kit. DO NOT EDIT. --> ```yaml "proxy": .gloo.solo.io.Proxy "modifiedResources": .gloo.solo.io.ModifiedResources "deletedResources": .gloo.solo.io.DeletedResources ``` | Field | Type | Description | | -- | - | -- | | `proxy` | | Optional. If a proxy is provided in the request, the response will contain only the report for that proxy. If no proxy is provided, the response will contain a report for each proxy in the Gloo API snapshot. | | `modifiedResources` | | Resources to be created or modified. Only one of `modifiedResources` or `deletedResources` can be set. | | `deletedResources` | | Resources to be deleted. Only one of `deletedResources` or `modifiedResources` can be set. | ```yaml "validationReports": []gloo.solo.io.ValidationReport ``` | Field | Type | Description | | -- | - | -- | | `validationReports` | | This list contains a validation report for each proxy that was translated and validated with the proposed Gloo API snapshot. | ```yaml "upstreams": []gloo.solo.io.Upstream ``` | Field | Type | Description | | -- | - | -- | | `upstreams` | | Optional, a list of the upstreams to create or modify. | ```yaml "upstreamRefs": []core.solo.io.ResourceRef "secretRefs": []core.solo.io.ResourceRef ``` | Field | Type | Description | | -- | - | -- | | `upstreamRefs` | | Optional, a list of the upstreams to delete. | | `secretRefs` | | Optional, a list of the secrets to delete. | A validation report represents the warnings and errors that produced during a single translation loop of a proxy. ```yaml "proxyReport": .gloo.solo.io.ProxyReport "upstreamReports": []gloo.solo.io.ResourceReport "proxy": .gloo.solo.io.Proxy ``` | Field | Type | Description | | -- | - | -- | | `proxyReport` | | The report for this proxy, including any warnings or errors in its sub-resources. | | `upstreamReports` | | The reports for all upstreams that were translated with this proxy. | | `proxy` | | The proxy for this translation loop. | ```yaml "resourceRef": .core.solo.io.ResourceRef "warnings": []string "errors": []string ``` | Field | Type | Description | | -- | - | -- | | `resourceRef` | | A way to refer to resources in different namespaces by including the name and namespace of the resource in this `resourceRef`. | | `warnings` | `[]string` | The warnings that are returned for the resource. Warnings do not necessarily prevent an operation from happening, but might require action. | | `errors` | `. | ```yaml ``` | Field | Type | Description | | -- | - | -- | ```yaml ``` | Field | Type | Description | | -- | - | -- | The Proxy Report should contain one report for each sub-resource of the Proxy E.g., each listener will have a corresponding report. Within each listener report is a route report corresponding to each route on the listener. If the report contains no errors, the (sub-)resource is valid. ```yaml "listenerReports": []gloo.solo.io.ListenerReport ``` | Field | Type | Description | | -- | - | -- | | `listenerReports` | | | ```yaml "errors": []gloo.solo.io.ListenerReport.Error "httpListenerReport": .gloo.solo.io.HttpListenerReport "tcpListenerReport": .gloo.solo.io.TcpListenerReport "hybridListenerReport": .gloo.solo.io.HybridListenerReport "aggregateListenerReport":

``` | Field | Type | Description | | -- | - | -- | | `errors` | | errors on top-level config of the listener. | | `httpListenerReport` | | report for the http listener. Only one of `httpListenerReport`, `tcpListenerReport`, `hybridListenerReport`, or `aggregateListenerReport` can be set. | | `tcpListenerReport` | | report for the tcp listener. Only one of `tcpListenerReport`, `httpListenerReport`, `hybridListenerReport`, or `aggregateListenerReport` can be set. | | `hybridListenerReport` | | report for the hybrid listener. Only one of `hybridListenerReport`, `httpListenerReport`, `tcpListenerReport`, or `aggregateListenerReport` can be set. | | `aggregateListenerReport` | | report for the aggregate listener. Only one of `aggregateListenerReport`, `httpListenerReport`, `tcpListenerReport`, or `hybridListenerReport` can be set. | error types for top-level listener config ```yaml "type": .gloo.solo.io.ListenerReport.Error.Type "reason": string ``` | Field | Type | Description | | -- | - | -- | | `type` | | the type of the error. | | `reason` | `string` | any extra info as a string. | | Name | Description | | -- | -- | | `NameNotUniqueError` | | | `BindPortNotUniqueError` | | | `SSLConfigError` | | | `ProcessingError` | | ```yaml "errors": []gloo.solo.io.HttpListenerReport.Error "virtualHostReports": []gloo.solo.io.VirtualHostReport ``` | Field | Type | Description | | -- | - | -- | | `errors` | | | | `virtualHostReports` | | report for nested virtual hosts. | error types for top-level http listener config ```yaml "type": .gloo.solo.io.HttpListenerReport.Error.Type "reason": string "metadata": .gloo.solo.io.SourceMetadata ``` | Field | Type | Description | | -- | - | -- | | `type` | | the type of the error. | | `reason` | `string` | any extra info as a string. | | `metadata` | | Source metadata for the HttpListenerReport, can be used by external components to associate sources with the HttpListenerError. | | Name | Description | | -- | -- | | `ProcessingError` | | ```yaml "errors": []gloo.solo.io.VirtualHostReport.Error "routeReports": []gloo.solo.io.RouteReport ``` | Field | Type | Description | | -- | - | -- | | `errors` | | errors on top-level config of the virtual host. | | `routeReports` | | | error types for top-level virtual host config ```yaml "type": .gloo.solo.io.VirtualHostReport.Error.Type "reason": string "metadata": .gloo.solo.io.SourceMetadata ``` | Field | Type | Description | | -- | - | -- | | `type` | | the type of the error. | | `reason` | `string` | any extra info as a string. | | `metadata` | | Source metadata for the VirtualHostReport, can be used by external components to associate sources with the VirtualHostError. | | Name | Description | | -- | -- | | `NameNotUniqueError` | | | `DomainsNotUniqueError` | | | `ProcessingError` | | | `EmptyDomainError` | | ```yaml "errors": []gloo.solo.io.RouteReport.Error "warnings": []gloo.solo.io.RouteReport.Warning ``` | Field | Type | Description | | -- | - | -- | | `errors` | | errors on the config of the route. | | `warnings` | | warnings on the config of the route. | error types for the given route config ```yaml "type": .gloo.solo.io.RouteReport.Error.Type "reason": string "metadata": .gloo.solo.io.SourceMetadata ``` | Field | Type | Description | | -- | - | -- | | `type` | | the type of the error. | | `reason` | `string` | any extra info as a

| | `metadata` | | Source metadata for the RouteReport, can be used by external components to associate sources with the RouteError. | | Name | Description | | -- | -- | | `InvalidMatcherError` | | | `ProcessingError` | | warning types for the given route config ```yaml "type": .gloo.solo.io.RouteReport.Warning.Type "reason": string ``` | Field | Type | Description | | -- | - | -- | | `type` | | the type of the error. | | `reason` | `string` | any extra info as a string. | | Name | Description | | -- | -- | | `InvalidDestinationWarning` | | ```yaml "errors": []gloo.solo.io.TcpListenerReport.Error "tcpHostReports": []gloo.solo.io.TcpHostReport ``` | Field | Type | Description | | -- | - | -- | | `errors` | | errors on top-level config of the listener. | | `tcpHostReports` | | | error types for top-level tcp listener config ```yaml "type": .gloo.solo.io.TcpListenerReport.Error.Type "reason": string ``` | Field | Type | Description | | -- | - | -- | | `type` | | the type of the error. | | `reason` | `string` | any extra info as a string. | | Name | Description | | -- | -- | | `NameNotUniqueError` | | | `BindPortNotUniqueError` | | | `SSLConfigError` | | | `ProcessingError` | | ```yaml "errors": []gloo.solo.io.TcpHostReport.Error "warnings": []gloo.solo.io.TcpHostReport.Warning ``` | Field | Type | Description | | -- | - | -- | | `errors` | | errors on the tcp host. | | `warnings` | | warnings on the config of the tcp host. | error types for tcp host config ```yaml "type": .gloo.solo.io.TcpHostReport.Error.Type "reason": string ``` | Field | Type | Description | | -- | - | -- | | `type` | | the type of the error. | | `reason` | `string` | any extra info as a string. | | Name | Description | | -- | -- | | `NameNotUniqueError` | | | `InvalidDestinationError` | | | `ProcessingError` | | warning types for the given tcp host config ```yaml "type": .gloo.solo.io.TcpHostReport.Warning.Type "reason": string ``` | Field | Type | Description | | -- | - | -- | | `type` | | the type of the warning. | | `reason` | `string` | any extra info as a string. | | Name | Description | | -- | -- | | `UnknownWarning` | | | `InvalidDestinationWarning` | | ```yaml "matchedListenerReports": map<string, .gloo.solo.io.MatchedListenerReport> ``` | Field | Type | Description | | -- | - | -- | | `matchedListenerReports` | `map<string, .gloo.solo.io.MatchedListenerReport>` | map key should uniquely identify MatchedListenerReport by matcher. | ```yaml "httpListenerReport": .gloo.solo.io.HttpListenerReport "tcpListenerReport": .gloo.solo.io.TcpListenerReport ``` | Field | Type | Description | | -- | - | -- | | `httpListenerReport` | | Only one of `httpListenerReport` or `tcpListenerReport` can be set. | | `tcpListenerReport` | | Only one of `tcpListenerReport` or `httpListenerReport` can be set. | the report for an AggregateListener ```yaml "httpListenerReports": map<string, .gloo.solo.io.HttpListenerReport> "tcpListenerReports": map<string, .gloo.solo.io.TcpListenerReport> ``` | Field | Type | Description | | -- | - | -- | | `httpListenerReports` | `map<string, .gloo.solo.io.HttpListenerReport>` | | | `tcpListenerReports` | `map<string, .gloo.solo.io.TcpListenerReport>` | | <!-- Start of HubSpot Embed Code --> <script type="text/javascript" id="hs-script-loader" async defer src="//js.hs-scripts.com/5130874.js"></script> <!-- End of HubSpot Embed Code -->