Better user-key documentation directions #171
Conversation
|
Sure thing! Will make the modifications and also add some more usage examples using pynetbox. |
[add] table of contents & Pynetbox usage topics
[add] Pynetbox examples
|
I've made the changes as well as added a whole I fixed an error where the API endpoints where I changed some text in order to make the documentation a bit more readable. Please check it out, specially the Pynetbox section. Obs.: Not every pynetbox example has been tested, in order to do these i'd like first your opinion on the documentation arrangement :) |
| "plaintext": "foobar", | ||
| } | ||
|
|
||
| nb.plugins.secrets.secrets.create(data=secret, session=session) |
There was a problem hiding this comment.
Sorry for stepping in but I found an error calling the pynetbox API here:
Using this line from the example, I got
ynetbox.core.query.RequestError: The request failed with code 400 Bad Request: {'assigned_object_type': ['This field is required.'], 'assigned_object_id': ['This field is required.'], 'role': ['This field is required.'], 'plaintext': ['This field is required.']}
After trying around a bit, I got it working by using this call instead nb.plugins.secrets.secrets.create(secret) because create() is defined as create(*args, **kwargs), taking the properties of the objects to be created directly, or a list of them as dicts. See https://pynetbox.readthedocs.io/en/latest/endpoint.html#pynetbox.core.endpoint.Endpoint.create
Nevertheless this documentation enhancement is awesome.
There was a problem hiding this comment.
Good one!
I've not tested everything, just put on what I thought would work. I'll take some time to test everything up and update the pull request.
Thanks for the correction!
|
Before releasing the plugin for v4.2, I'll go through this doc and make sure it's good to merge. I'd rather have this change with the newer release than add to existing ones. |
|
That's perfect! I'm aiming to upgrade to v4.2 and |
|
|
||
| ```json | ||
| { | ||
| "private_key": "<private key>" |
There was a problem hiding this comment.
The API payload also requires the user_keys field to activate the user keys. This field should be a list in the following format:
{
"user_keys": [1, 2]
}
Here, the integers represent the user IDs.
Please ensure to test the API thoroughly when writing its documentation to confirm proper functionality and accuracy.
|
|
||
| ```json | ||
| { | ||
| "private_key": "<private key>" |
There was a problem hiding this comment.
I noticed that it doesn't mention the optional preserve_key field in the payload. This field allows users to reuse an existing session key instead of creating a new one.
| "plaintext": "foobar", | ||
| } | ||
|
|
||
| nb.plugins.secrets.secrets.update(id=1, data=secret, session=session) |
There was a problem hiding this comment.
The update method requires the id to be included in the payload rather than as a parameter. Here is the correct payload example:
secret = {
"id": 1,
"assigned_object_type": "dcim.device",
"assigned_object_id": 35,
"role": 1,
"name": "admin",
"plaintext": "foobar",
}
nb.plugins.secrets.secrets.update([secret])
Make sure to pass the payload in this format when updating an instance.
If we want to update a single instance, we first need to fetch the instance and then update it like this:
x = nb.dcim.devices.get(1)
x.update({
"name": "test-switch2",
"serial": "ABC321",
})
|
sure thing. I will aim to add a |
Description
The following files where modified:
The following files where created:
Type of Change
Test Cases
Additional Information
I made the changes based on a difficulty I had when first-time configuring secrets. I did find the proper documentation by
docs/models/userkey.mdbut nothing was pointing to it at theREADME.mdand nothing was said about the need to click on the save button for properly saving my new generated keys.