GNS3 / gns3-server

GNS3 server
GNU General Public License v3.0
811 stars 263 forks source link

API documentation examples lacks /v1 #116

Closed ghost closed 9 years ago

ghost commented 9 years ago

In docs/api/examples in all examples the url doesn't have the starting "/v1" part in the path, e.g in get_interfaces .txt it says:

curl -i -X GET 'http://localhost:8000/interfaces'

But that will not work:

$ curl -i -X GET 'http://192.168.1.10:8000/interfaces'
HTTP/1.1 404 Not Found
CONTENT-TYPE: text/plain; charset=utf-8
CONTENT-LENGTH: 14
CONNECTION: keep-alive
DATE: Mon, 30 Mar 2015 08:32:36 GMT
SERVER: Python/3.4 aiohttp/0.14.4

404: Not Found

It needs a starting /v1 in the path:

$ curl -i -X GET 'http://192.168.1.10:8000/v1/interfaces'
HTTP/1.1 200 OK
SERVER: Python/3.4 GNS3/1.3.0rc2
X-ROUTE: /v1/interfaces
CONTENT-TYPE: application/json
CONTENT-LENGTH: 520
CONNECTION: keep-alive
DATE: Mon, 30 Mar 2015 08:32:57 GMT

[
    {
        "id": "lo0",
        "name": "lo0"
    },
...
]
julien-duponchelle commented 9 years ago

Nice catch

julien-duponchelle commented 9 years ago

Documentation is building

julien-duponchelle commented 9 years ago

Done