Skip to content

Commit

Permalink
Update cli docs (#1763)
Browse files Browse the repository at this point in the history
Contributes towards #1531
  • Loading branch information
RobbeSneyders authored Oct 29, 2023
1 parent 4556779 commit 99c7a13
Showing 1 changed file with 3 additions and 10 deletions.
13 changes: 3 additions & 10 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ For convenience Connexion provides a command-line interface
(CLI). This interface aims to be a starting point in developing or
testing OpenAPI specifications with Connexion.

The available commands are:

- ``connexion run``

All commands can run with -h or --help to list more information.

Running an OpenAPI specification
--------------------------------

Expand All @@ -22,12 +16,11 @@ To run your specification, execute in your shell:

.. code-block:: bash
$ connexion run your_api.yaml --stub --debug
$ connexion run your_api.yaml --stub
This command will tell Connexion to run the ``your_api.yaml``
specification file attaching a stub operation (``--stub``) to the
unavailable operations/functions of your API and in debug mode
(``--debug``).
unavailable operations/functions of your API, which will return a ``501 Not Implemented`` response.

The basic usage of this command is:

Expand Down Expand Up @@ -58,4 +51,4 @@ Your API specification file is not required to have any ``operationId``.

.. code-block:: bash
$ connexion run your_api.yaml --mock=all -v
$ connexion run your_api.yaml --mock=all

0 comments on commit 99c7a13

Please sign in to comment.