Commit Graph

14 Commits (master)

Author SHA1 Message Date
neil 7362e8de4d fix format 4 months ago
Sergey Ponomarev 6b7b5caf54 DNS provider API: structured description
Instead of using comments declare info in a special variable.
Then the variable can be used to print the DNS API provider usage.
The usage can be parsed on UI and show all needed inputs for options.

The info is stored in plain string that it's both human-readable and easy to parse:

    dns_example_info='API name
     An extended description.
     Multiline.
    Domains: list of alternative domains to find
    Site: the dns provider website e.g. example.com
    Docs: Link to ACME.sh wiki for the provider
    Options:
     VARIABLE1 Title for the option1.
     VARIABLE2 Title for the option2. Default "default value".
     VARIABLE3 Title for the option3. Description to show on UI. Optional.
    Issues: Link to a support ticket on https://github.com/acmesh-official/acme.sh
    Author: First Lastname <authoremail@example.com>, Another Author <https://github.com/example>;
    '

Here:
VARIABLE1 will be required.
VARIABLE2 will be required too but will be populated with a "default value".
VARIABLE3 is optional and can be empty.

A DNS provider may have alternative options like CloudFlare may use API KEY or API Token.
You can use a second section OptionsAlt: section.

Some providers may have alternative names or domains e.g. Aliyun and AlibabaCloud.
Add them to Domains: section.

Signed-off-by: Sergey Ponomarev <stokito@gmail.com>
9 months ago
Arash Hatami 0c0d1d4e52
Update duplicate message 2 years ago
Arash Hatami eab9603921
Fix SH format 2 years ago
Arash Hatami c07db3aa14
add 'Accept' header 2 years ago
Arash Hatami 4610204c83
Test CI 2 years ago
Arash Hatami f4ed1b32b8
Update dns_arvan.sh
Update API URL
2 years ago
Vahid Fardi d9a8b057c3 change name actor 4 years ago
Vahid Fardi 2ec6215b1c change Author name 4 years ago
Vahid Fardi c59a8c9644 change arvan api script 4 years ago
neil 19c4345162 fix shfmt 5 years ago
neil d842ccb287 fix format error 5 years ago
Ehsan Aliakbar 200cd5972a fix shellcheck errors in Arvan Dns Api 5 years ago
Ehsan Aliakbar 4fa59ea04e Adding Arvan Dns Api 5 years ago