python-openstackclient/doc/source/specs/command-objects/example.rst
Richard Theis 7b110511d2 Doc: Add optional command specs process
The developer documentation has been updated to include an
optional command specs process. This process may be used
to work out the specifications for new commands, objects
and actions before their implementation.

This new process could assist in the implementation of
additional neutron support in OSC.

Change-Id: I62f7472435a9caacee0d1b4c8d35417c123b5a44
2015-12-14 08:40:30 -06:00

1.3 KiB

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

example create

os example create
    <name>

<name>

New example name

example delete

Delete example(s)

example delete

os example delete
    <example> [<example> ...]

<example>

Example to delete (name or ID)

example list

List examples

example list

os example list

example set

Set example properties

example set

os example set
    [--name <new-name>]
    <example>

--name <new-name>

New example name

<example>

Example to modify (name or ID)

example show

Display example details

example show

os example show
    <example>

<example>

Example to display (name or ID)