arno/gns3-server
1
0
Fork 0
mirror of https://github.com/GNS3/gns3-server synced 2025-02-17 18:42:00 +00:00
Code Issues Releases Wiki Activity

Bold parameter in documentation in order to improve readability

Browse Source
This commit is contained in:
Julien Duponchelle 2015-01-20 15:31:27 +01:00
parent f5ac73d1ca
commit 78237e9fb6
5 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api/examples/post_project.txt
View File

@ -1,8 +1,8 @@
curl -i -X POST 'http://localhost:8000/project' -d '{"location": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-328/test_create_project_with_dir0"}' curl -i -X POST 'http://localhost:8000/project' -d '{"location": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-330/test_create_project_with_dir0"}'
POST /project HTTP/1.1 POST /project HTTP/1.1
{ {
"location": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-328/test_create_project_with_dir0" "location": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-330/test_create_project_with_dir0"
} }
@ -15,6 +15,6 @@ SERVER: Python/3.4 aiohttp/0.13.1
X-ROUTE: /project X-ROUTE: /project
{ {
"location": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-328/test_create_project_with_dir0", "location": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-330/test_create_project_with_dir0",
"uuid": "b4432fe3-6743-4ce7-ab05-1f5637d04cd6" "uuid": "e7d2911f-e367-46d9-b426-25663d0bb601"
} }

8
docs/api/vpcsuuidportsportidnio.rst
View File

@ -3,14 +3,14 @@
.. contents:: .. contents::
POST /vpcs/{uuid}/ports/{port_id}/nio POST /vpcs/**{uuid}**/ports/**{port_id}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add a NIO to a VPCS Add a NIO to a VPCS
Parameters Parameters
********** **********
- **port_id**: Id of the port where the nio should be add
- **uuid**: VPCS instance UUID - **uuid**: VPCS instance UUID
- **port_id**: Id of the port where the nio should be add
Response status codes Response status codes
********************** **********************
@ -25,14 +25,14 @@ Sample session
.. literalinclude:: examples/post_vpcsuuidportsportidnio.txt .. literalinclude:: examples/post_vpcsuuidportsportidnio.txt
DELETE /vpcs/{uuid}/ports/{port_id}/nio DELETE /vpcs/**{uuid}**/ports/**{port_id}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Remove a NIO from a VPCS Remove a NIO from a VPCS
Parameters Parameters
********** **********
- **port_id**: ID of the port where the nio should be removed
- **uuid**: VPCS instance UUID - **uuid**: VPCS instance UUID
- **port_id**: ID of the port where the nio should be removed
Response status codes Response status codes
********************** **********************

2
docs/api/vpcsuuidstart.rst
View File

@ -3,7 +3,7 @@
.. contents:: .. contents::
POST /vpcs/{uuid}/start POST /vpcs/**{uuid}**/start
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start a VPCS instance Start a VPCS instance

2
docs/api/vpcsuuidstop.rst
View File

@ -3,7 +3,7 @@
.. contents:: .. contents::
POST /vpcs/{uuid}/stop POST /vpcs/**{uuid}**/stop
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stop a VPCS instance Stop a VPCS instance

2
gns3server/web/documentation.py
View File

@ -37,7 +37,7 @@ class Documentation(object):
f.write('{}\n---------------------------------------------\n\n'.format(path)) f.write('{}\n---------------------------------------------\n\n'.format(path))
f.write('.. contents::\n') f.write('.. contents::\n')
for method in handler_doc["methods"]: for method in handler_doc["methods"]:
f.write('\n{} {}\n'.format(method["method"], path)) f.write('\n{} {}\n'.format(method["method"], path.replace("{", '**{').replace("}", "}**")))
f.write('~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n') f.write('~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n')
f.write('{}\n\n'.format(method["description"])) f.write('{}\n\n'.format(method["description"]))