openstack/python-openstackclient
Code Issues Proposed changes

Merge "Remove contributor specs"

Browse Source
This commit is contained in:
Zuul 2025-04-01 12:44:05 +00:00 committed by Gerrit Code Review
commit c0521743ba
4 changed files with 0 additions and 175 deletions
doc/source/contributor
index.rst
specs
command-objects
example.rst
commands.rstnetwork-topology.rst

1
doc/source/contributor/index.rst

@ -11,7 +11,6 @@
command-wrappers command-wrappers
command-errors command-errors
command-logs command-logs
specs/commands
plugins plugins
humaninterfaceguide humaninterfaceguide
api/modules api/modules

86
doc/source/contributor/specs/command-objects/example.rst

@ -1,86 +0,0 @@
=======
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)

44
doc/source/contributor/specs/commands.rst

@ -1,44 +0,0 @@
=============
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/*

44
doc/source/contributor/specs/network-topology.rst

@ -1,44 +0,0 @@
================
network topology
================
A **network topology** shows a topological graph about
devices which connect to the specific network. Also, it
will return availability information for each individual
device within the network as well. One other thing to note
is that it is the intention for OSC to collect data from
existing REST APIs
Network v2
network topology list
---------------------
List network topologies
.. program:: network topology list
.. code:: bash
openstack network topology list
[--project <project>]
.. option:: --project <project>
List network topologies for given project
(name or ID)
network topology show
---------------------
Show network topology details
.. program:: network topology show
.. code:: bash
openstack network topology show
<network>
.. _network_topology_show-network:
.. describe:: <network>
Show network topology for a specific network (name or ID)