Skip to content

Commit 5c59702

Browse files
committed
added cli4 --dump documentation
1 parent f89c64b commit 5c59702

3 files changed

Lines changed: 38 additions & 3 deletions

File tree

CloudFlare/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
from cloudflare import CloudFlare
44

5-
__version__ = '1.2.2'
5+
__version__ = '1.2.3'

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,8 @@ All API calls can be called from the command line.
275275
The command will convert domain names on-the-fly into zone_identifier's.
276276

277277
```bash
278-
$ cli4 [-V|--version] [-h|--help] [-v|--verbose] [-q|--quiet] [-j|--json] [-y|--yaml] [-r|--raw] [--get|--patch|--post|-put|--delete] [item=value ...] /command...
278+
$ cli4 [-V|--version] [-h|--help] [-v|--verbose] [-q|--quiet] [-j|--json] [-y|--yaml] [-r|--raw] [-d|--dump] [--get|--patch|--post|-put|--delete] [item=value ...] /command...
279+
279280
```
280281

281282
For API calls that need a set of date or parameters passed there is a item=value format.
@@ -440,6 +441,22 @@ $
440441

441442
## Implemented API calls
442443

444+
The **--dump** argument to cli4 will produce a list of all the call implemented within the library.
445+
446+
```bash
447+
$ cli4 --dump
448+
/certificates
449+
/ips
450+
/organizations
451+
...
452+
/zones/ssl/analyze
453+
/zones/ssl/certificate_packs
454+
/zones/ssl/verification
455+
$
456+
```
457+
458+
### Table of commands
459+
443460
|`GET` |`PUT` |`POST` |`PATCH` |`DELETE`|API call|
444461
|--------|--------|--------|--------|--------|:--------|
445462
|`GET` | |`POST` | |`DELETE`|/certificates|

README.rst

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ convert domain names on-the-fly into zone\_identifier's.
311311

312312
.. code:: bash
313313
314-
$ cli4 [-V|--version] [-h|--help] [-v|--verbose] [-q|--quiet] [-j|--json] [-y|--yaml] [-r|--raw] [--get|--patch|--post|-put|--delete] [item=value ...] /command...
314+
$ cli4 [-V|--version] [-h|--help] [-v|--verbose] [-q|--quiet] [-j|--json] [-y|--yaml] [-r|--raw] [-d|--dump] [--get|--patch|--post|-put|--delete] [item=value ...] /command...
315315
316316
For API calls that need a set of date or parameters passed there is a
317317
item=value format. If you want a numeric value passed, then *==* can be
@@ -483,6 +483,24 @@ DNSSEC CLI examples
483483
Implemented API calls
484484
---------------------
485485

486+
The **--dump** argument to cli4 will produce a list of all the call
487+
implemented within the library.
488+
489+
.. code:: bash
490+
491+
$ cli4 --dump
492+
/certificates
493+
/ips
494+
/organizations
495+
...
496+
/zones/ssl/analyze
497+
/zones/ssl/certificate_packs
498+
/zones/ssl/verification
499+
$
500+
501+
Table of commands
502+
~~~~~~~~~~~~~~~~~
503+
486504
+-----------+-----------+------------+-------------+--------------+---------------------------------------------------------------+
487505
| ``GET`` | ``PUT`` | ``POST`` | ``PATCH`` | ``DELETE`` | API call |
488506
+===========+===========+============+=============+==============+===============================================================+

0 commit comments

Comments
 (0)