Skip to content

Commit

Permalink
feat(cor-923) Add proper description for check domain statuses (#687)
Browse files Browse the repository at this point in the history
  • Loading branch information
mzottola authored Aug 7, 2024
1 parent 64b21ad commit 12bd59e
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18733,6 +18733,14 @@ components:
- DOMAIN_NOT_CONFIGURED
- DOMAIN_LINKED_TO_WRONG_HOST
- GENERIC_FAILURE
description: |
This enum represents the final status for your domain.
There are 2 successful statuses:
* `RESOLVES_TO_IP`: we succeeded to resolve an IP to your domain. This is the successful final status for custom domains where `use_cdn` is `true`
* `MATCHES_LOAD_BALANCER_HOST`: we succeeded to lookup CNAMEs & found that it matches your cluser Load Balancer host. This is the successful final status for custom domain where `use_cdn` is `false`
* `DOMAIN_NOT_CONFIGURED`: the domain is not configured, look at the `error_details` field for more information
* `DOMAIN_LINKED_TO_WRONG_HOST`: the domain has CNAME(s) that matches a different host than your Load Balancer one
* `GENERIC_FAILURE`: an error occured when attempting to validate your domain, look at the `error_details` field for more information
CheckedCustomDomainResponse:
title: CheckedCustomDomainResponse
type: object
Expand Down

0 comments on commit 12bd59e

Please sign in to comment.