Skip to content

Document rendered zone file #6

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

Merged
merged 1 commit into from
Dec 20, 2017
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
27 changes: 25 additions & 2 deletions src/data/objects/domain.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ schema:
isArray: true
subtype: string
filterable: true
value:
value:
- "127.0.0.1"
- "255.255.255.1"
- "123.123.123.7"
Expand All @@ -87,7 +87,7 @@ schema:
type: string
isArray: true
subtype: string
value:
value:
- "44.55.66.77"
optional: true
description: >
Expand All @@ -107,6 +107,25 @@ schema:
filterable: true
subtype: domain_type
description: Controls the Domain type.
zonefile:
type: Object
description: >
Information about the rendered zone file. This shows what is live right
now, and recent changes may take a minute to be reflected in this value.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it an actual minute? I thought it could take up to fifteen minutes?

If it's more than an actual minute, we should specify with "may take up to ..." kind of message.

rendered:
type: String
description: >
The rendered zone file as it is right now. This value is refreshed
periodically, and may take a minute to reflect changes.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

editable: false
value: ""
status:
type: Enum
subtype: rendered_status
value: setting_up
description: >
Whether the rendered domain file is up to date. When changes have been
made and the file has not yet refreshed, this will say so.
enums:
status:
active : Turn on serving of this Domain.
Expand All @@ -115,3 +134,7 @@ enums:
domain_type:
master: A primary, authoritative Domain
slave: A secondary Domain which gets its updates from a master Domain.
rendered_status:
current: The rendered zone file is up to date.
setting_up: This domain was just created and is being rendered for the first time.
updating: This domain has been updated and will be re-rendered shortly.