mirror of
https://github.com/GNS3/gns3-server
synced 2024-11-24 09:18:08 +00:00
Bold parameter in documentation in order to improve readability
This commit is contained in:
parent
f5ac73d1ca
commit
78237e9fb6
@ -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
|
||||
{
|
||||
"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
|
||||
|
||||
{
|
||||
"location": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-328/test_create_project_with_dir0",
|
||||
"uuid": "b4432fe3-6743-4ce7-ab05-1f5637d04cd6"
|
||||
"location": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-330/test_create_project_with_dir0",
|
||||
"uuid": "e7d2911f-e367-46d9-b426-25663d0bb601"
|
||||
}
|
||||
|
@ -3,14 +3,14 @@
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /vpcs/{uuid}/ports/{port_id}/nio
|
||||
POST /vpcs/**{uuid}**/ports/**{port_id}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Add a NIO to a VPCS
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **port_id**: Id of the port where the nio should be add
|
||||
- **uuid**: VPCS instance UUID
|
||||
- **port_id**: Id of the port where the nio should be add
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@ -25,14 +25,14 @@ Sample session
|
||||
.. 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
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **port_id**: ID of the port where the nio should be removed
|
||||
- **uuid**: VPCS instance UUID
|
||||
- **port_id**: ID of the port where the nio should be removed
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
@ -3,7 +3,7 @@
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /vpcs/{uuid}/start
|
||||
POST /vpcs/**{uuid}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a VPCS instance
|
||||
|
||||
|
@ -3,7 +3,7 @@
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /vpcs/{uuid}/stop
|
||||
POST /vpcs/**{uuid}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a VPCS instance
|
||||
|
||||
|
@ -37,7 +37,7 @@ class Documentation(object):
|
||||
f.write('{}\n---------------------------------------------\n\n'.format(path))
|
||||
f.write('.. contents::\n')
|
||||
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\n'.format(method["description"]))
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user