summaryrefslogtreecommitdiff
path: root/doc/source/contributor/specs/command-objects/example.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/contributor/specs/command-objects/example.rst')
-rw-r--r--doc/source/contributor/specs/command-objects/example.rst86
1 files changed, 86 insertions, 0 deletions
diff --git a/doc/source/contributor/specs/command-objects/example.rst b/doc/source/contributor/specs/command-objects/example.rst
new file mode 100644
index 00000000..fa559433
--- /dev/null
+++ b/doc/source/contributor/specs/command-objects/example.rst
@@ -0,0 +1,86 @@
+=======
+example
+=======
+
+This is a specification for the ``example`` command object. It is not intended
+to be a complete template for new commands since other actions, options
+and/or arguments may be used. You can include general specification information
+before the commands below. This information could include links to related material
+or descriptions of similar commands.
+
+[example API name] [example API version]
+
+example create
+--------------
+
+Create new example
+
+.. program:: example create
+.. code:: bash
+
+ openstack example create
+ <name>
+
+.. describe:: <name>
+
+ New example name
+
+example delete
+--------------
+
+Delete example(s)
+
+.. program:: example delete
+.. code:: bash
+
+ openstack example delete
+ <example> [<example> ...]
+
+.. describe:: <example>
+
+ Example(s) to delete (name or ID)
+
+example list
+------------
+
+List examples
+
+.. program:: example list
+.. code:: bash
+
+ openstack example list
+
+example set
+-----------
+
+Set example properties
+
+.. program:: example set
+.. code:: bash
+
+ openstack example set
+ [--name <new-name>]
+ <example>
+
+.. option:: --name <new-name>
+
+ New example name
+
+.. describe:: <example>
+
+ Example to modify (name or ID)
+
+example show
+------------
+
+Display example details
+
+.. program:: example show
+.. code:: bash
+
+ openstack example show
+ <example>
+
+.. describe:: <example>
+
+ Example to display (name or ID)