python-openstackclient/doc/source/contributor/specs/commands.rst

=============
Command Specs
=============

Specifications for new commands, objects and actions are listed below.
These specifications have not been implemented. See
:ref:`command-list` for implemented commands and
:ref:`command-structure` for implemented objects and actions.

It is optional to propose a specifications patch for new commands,
objects and actions here before submitting the implementation. Once your
specifications patch merges then you may proceed with the implementation.
Your implementation patches should move applicable portions of the
specifications patch to the official :ref:`command-list`
and :ref:`command-structure` documentation.

Objects Specs
-------------

Add specifications for new objects based on the ``example`` object.

Actions Specs
-------------

Add specifications for new actions based on the ``example`` action.

.. toctree::
   :maxdepth: 1

   network-topology

Commands Specs
--------------

Add specifications for new commands based on the commands for the
``example`` object. The ``example`` commands are not intended to
be a complete template for new commands since other actions, options
and/or arguments may be used.

.. toctree::
   :glob:
   :maxdepth: 2

   command-objects/*