Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cor-923) Add proper description for check domain statuses #687

Merged
merged 1 commit into from
Aug 7, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading