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

chore(spec): Add documentation for links response #433

Merged
merged 1 commit into from
Aug 29, 2023
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
11 changes: 11 additions & 0 deletions src/schemas/LinkResponse.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,20 @@ properties:
type: string
internal_port:
type: integer
description: "The port from which the service is reachable from within the cluster"
external_port:
type: integer
description: "The port from which the service is reachable from externally (i.e: 443 for HTTPS)"
is_qovery_domain:
type: boolean
description: "True if the domain is managed by Qovery, false if it belongs to the user"
is_default:
type: boolean
description: |
Indicate if the link is using the root of the domain and not one derivated from port
i.e:
p8080.zxxxx.jvm.worl => is_default = false, is_qovery = true
zxxxx.jvm.world => is_default = true, is_qovery = true
p8080-my-super-domain.com => is_default = false, is_qovery = false
my-super-domain.com => is_default = true, is_qovery = false

Loading