LukeParke/connexion
1
0
Fork 0
mirror of https://github.com/LukeHagar/connexion.git synced 2025-12-06 12:27:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update cli docs (#1763)

Browse Source 
Contributes towards #1531
This commit is contained in:
Robbe Sneyders
2023-10-29 14:23:21 +01:00
committed by GitHub
parent 4556779343
commit 99c7a13b53
1 changed files with 3 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/cli.rst
View File

@@ -4,12 +4,6 @@ For convenience Connexion provides a command-line interface
(CLI). This interface aims to be a starting point in developing or (CLI). This interface aims to be a starting point in developing or
testing OpenAPI specifications with Connexion. 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 Running an OpenAPI specification
-------------------------------- --------------------------------
@@ -22,12 +16,11 @@ To run your specification, execute in your shell:
.. code-block:: bash .. 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`` This command will tell Connexion to run the ``your_api.yaml``
specification file attaching a stub operation (``--stub``) to the specification file attaching a stub operation (``--stub``) to the
unavailable operations/functions of your API and in debug mode unavailable operations/functions of your API, which will return a ``501 Not Implemented`` response.
(``--debug``).
The basic usage of this command is: The basic usage of this command is:
@@ -58,4 +51,4 @@ Your API specification file is not required to have any ``operationId``.
.. code-block:: bash .. code-block:: bash
$ connexion run your_api.yaml --mock=all -v $ connexion run your_api.yaml --mock=all