Commit Graph

16 Commits (b8644f49eca968c435f8a58f1999d0205791d66e)

Author SHA1 Message Date
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
xpac1985 224cd04673
Shell formatting, again 4 years ago
xpac1985 52243d0870
Clean up formatting (SHFMT) 4 years ago
xpac1985 d519873fa4
Fix Infoblox_View handling + some cleanup
URL is now constructed after possible fallback value for Infoblox_View is being set
Infoblox_View is URLencoded to deal with e.g. spaces
Some cleanup, clearer log messages etc.
4 years ago
neilpang 0b797f5964 fix new shellcheck error 8 years ago
Rikard Gynnerstedt 0a301cdd21 added new line at the end of the file 8 years ago
Rikard Gynnerstedt b73f5a4e94 missed one egrep command 8 years ago
Rikard Gynnerstedt 3b74ac841e save Infoblox_View to account config 8 years ago
Rikard Gynnerstedt b6f00ea241 changed path to env 8 years ago
Rikard Gynnerstedt 0bd4a4f98f formated for sh instead of bash 8 years ago
Rikard Gynnerstedt 0b52645bb6 added view variable to infoblox integration script 8 years ago
Jason 1424e8a2de Added attribution 8 years ago
Jason 7dc548b4b8 MORE bs 8 years ago
Jason 2c37d94611 More bs 8 years ago
Jason b1e4a7c615 Fixed (hopefully) TravisCI errors 8 years ago
Jason b0561058c6 Infoblox API 8 years ago