From 4444da0f2c66b1116a298d50f359fb3275aa6287 Mon Sep 17 00:00:00 2001 From: Anthony Ruhier Date: Mon, 27 Mar 2017 17:26:32 +0200 Subject: [PATCH] Fix documentation Fix bad parameter Fix wrong function call (api instead of mapper) --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 37b1377..5d32574 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Initialize a new `NetboxAPI` object: ```python netbox_api = NetboxAPI( - url="netbox.example.com", login="login", password="password" + url="netbox.example.com", username="user", password="password" ) ``` @@ -52,7 +52,7 @@ Initialize a new `NetboxMapper` object: ```python netbox_api = NetboxAPI( - url="netbox.example.com", login="login", password="password" + url="netbox.example.com", username="user", password="password" ) netbox_mapper = NetboxMapper(netbox_api, app_name="dcim", model="sites") ``` @@ -60,7 +60,7 @@ netbox_mapper = NetboxMapper(netbox_api, app_name="dcim", model="sites") Then get all objects of the model: ```python ->>> sites = list(netbox_api.get()) +>>> sites = list(netbox_mapper.get()) [, , …] >>> print(sites[0].id) @@ -72,7 +72,7 @@ Then get all objects of the model: Or get a specific site by its id: ```python ->>> netbox_api.get(1) +>>> netbox_mapper.get(1) ```