Skip to content

Commit

Permalink
added cli4 --dump documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mahtin committed Oct 19, 2016
1 parent f89c64b commit 5c59702
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CloudFlare/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

from cloudflare import CloudFlare

__version__ = '1.2.2'
__version__ = '1.2.3'
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,8 @@ All API calls can be called from the command line.
The command will convert domain names on-the-fly into zone_identifier's.

```bash
$ cli4 [-V|--version] [-h|--help] [-v|--verbose] [-q|--quiet] [-j|--json] [-y|--yaml] [-r|--raw] [--get|--patch|--post|-put|--delete] [item=value ...] /command...
$ 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...

```

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

## Implemented API calls

The **--dump** argument to cli4 will produce a list of all the call implemented within the library.

```bash
$ cli4 --dump
/certificates
/ips
/organizations
...
/zones/ssl/analyze
/zones/ssl/certificate_packs
/zones/ssl/verification
$
```

### Table of commands

|`GET` |`PUT` |`POST` |`PATCH` |`DELETE`|API call|
|--------|--------|--------|--------|--------|:--------|
|`GET` | |`POST` | |`DELETE`|/certificates|
Expand Down
20 changes: 19 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ convert domain names on-the-fly into zone\_identifier's.

.. code:: bash
$ cli4 [-V|--version] [-h|--help] [-v|--verbose] [-q|--quiet] [-j|--json] [-y|--yaml] [-r|--raw] [--get|--patch|--post|-put|--delete] [item=value ...] /command...
$ 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...
For API calls that need a set of date or parameters passed there is a
item=value format. If you want a numeric value passed, then *==* can be
Expand Down Expand Up @@ -483,6 +483,24 @@ DNSSEC CLI examples
Implemented API calls
---------------------

The **--dump** argument to cli4 will produce a list of all the call
implemented within the library.

.. code:: bash
$ cli4 --dump
/certificates
/ips
/organizations
...
/zones/ssl/analyze
/zones/ssl/certificate_packs
/zones/ssl/verification
$
Table of commands
~~~~~~~~~~~~~~~~~

+-----------+-----------+------------+-------------+--------------+---------------------------------------------------------------+
| ``GET`` | ``PUT`` | ``POST`` | ``PATCH`` | ``DELETE`` | API call |
+===========+===========+============+=============+==============+===============================================================+
Expand Down

0 comments on commit 5c59702

Please sign in to comment.