fix(docs): simplify examples #968
Draft
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
peterthomassen
requested changes
Sep 16, 2024
docs/dyndns/update-api.rst
Outdated
| @@ -172,12 +172,9 @@ affiliated with the respective account (see :ref:`manage-tokens` for details.) | |||
| stand-in for an IPv6 address. Replace those (including the ``<`` and ``>``) | |||
| with your respective values. | |||
|
|
|||
| **Examples with headers** (recommended) | |||
There was a problem hiding this comment.
Please use some kind of subheading (not a regular paragraph)
docs/dyndns/update-api.rst
Outdated
|
|
||
| curl "https://update.dedyn.io/?hostname=<your domain>&myipv4=1.2.3.4&myipv6=fd08::1234" \ | ||
| --header "Authorization: Token <your token secret>" | ||
|
|
||
| **Examples without headers** (not recommended) |
There was a problem hiding this comment.
Please use some kind of subheading (not a regular paragraph)
docs/dyndns/update-api.rst
Outdated
|
|
||
| Basic authentication with automatic IP detection (IPv4 **or** IPv6):: | ||
|
|
||
| curl --user <your domain>:<your token secret> https://update.dedyn.io/ |
There was a problem hiding this comment.
Please indent correctly like in examples above. Also applies to examples below.
docs/dyndns/update-api.rst
Outdated
|
|
||
| Basic authentication with forced use of IPv4 (while preserving the IPv6 address from the DNS):: | ||
|
|
||
| curl --ipv4 --user <your domain>:<your token secret> "https://update.dedyn.io/&myipv6=preserve" |
There was a problem hiding this comment.
Quoting from #956 (review):
- Please make sure that all examples work
- Please make sure that all examples are technically correct
Have you tested this?
The first query parameter should be indicated with ?, not with &. (The quotes can then also go away, they are also needed because Linux command lines have special treatment for &.)
peterthomassen
requested changes
Sep 16, 2024
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.