update API documentation #154
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vbagirov
requested changes
Nov 3, 2023
| @@ -10,14 +10,99 @@ toc_max_heading_level: 4 | |||
| https://api.adguard-dns.io/static/swagger/openapi.json to markdown using | |||
| https://swagger-markdown-ui.netlify.app/. | |||
|
|
|||
| Changelog is from here: | |||
| https://api.adguard-dns.io/static/api/CHANGELOG.md | |||
|
|
|||
| If you want to change it, ask the developers to change the OpenAPI spec. | |||
| --> | |||
|
|
|||
| ## AdGuard DNS API | |||
There was a problem hiding this comment.
Should we remove these lines?
## AdGuard DNS API
DNS API documentation
There was a problem hiding this comment.
It's auto-generated, any change here will make it much more complex to apply updates
| ## Version: 1.4 | ||
| ## AdGuard DNS API Change Log | ||
|
|
||
| ### v1.0 |
There was a problem hiding this comment.
One could argue versions should go the other way around, from most recent to the oldest one
There was a problem hiding this comment.
It's also auto-generated
| ### v1.1 | ||
|
|
||
| - Added methods to retrieve statistics by time, domains, companies and devices. | ||
|
|
| here new field `safebrowsing_settings` is used instead of deprecated `safebrowsing_enabled`, whose value | ||
| stored in `block_dangerous_domains`. | ||
|
|
||
| ## Version: 1.5 |
There was a problem hiding this comment.
Changelog for v1.5 is already added above in this pull request, it's unclear what this "Version 1.5" means then
vbagirov
approved these changes
Nov 3, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.