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

blocklistConfig.json in today's reality #2

Closed
ignoramous opened this issue Jul 23, 2021 · 2 comments
Closed

blocklistConfig.json in today's reality #2

ignoramous opened this issue Jul 23, 2021 · 2 comments
Assignees

Comments

@ignoramous
Copy link
Contributor

ignoramous commented Jul 23, 2021

Now that the blocklists cat is out of the bag, time to get rid of an unused field and introduce a new one.

  • Remove unused field: uname. It was included for book-keeping purposes from when we tracked nextdns/metadata for reasons that don't exist anymore.

  • Add new optional string field: status, which can assume dead, alive, unknown to depict the state of the blocklist. Since we can't recycle values once assigned (unless version is bumped up), we'd have to keep those entries around for book-keeping purposes.

  • Add fields for homepage and a short description of the blocklist.

  • Overall, though, blocklistConfig.json must also capture its own version, so that's another field to introduce at the top-level.

@ignoramous
Copy link
Contributor Author

ignoramous commented Nov 7, 2022

Remove unused field: uname. It was included for book-keeping purposes from when we tracked nextdns/metadata for reasons that don't exist anymore.

uname will be retained mostly because older clients (The Rethink DNS + Firewall app below v053k) expect it. Perhaps, it could removed by oct 2023 (~1 year removed from v053k release).

Add new optional string field: status, which can assume dead, alive, unknown to depict the state of the blocklist. Since we can't recycle values once assigned (unless version is bumped up), we'd have to keep those entries around for book-keeping purposes.

pack is set to ["dead"] to denoted abandoned / deleted lists.

Overall, though, blocklistConfig.json must also capture its own version, so that's another field to introduce at the top-level.

Hard to introduce a version at this point without breaking clients. It is not strictly required since blocklist-config (and the resulting file-tag config) are implicitly versioned with timestamps to denote the time at which they were generated.

@ignoramous
Copy link
Contributor Author

Add fields for homepage and a short description of the blocklist.

Yes, see: #8

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants