[minor_change] Add nd_rest as a new generic ND REST API module. (DCNE-242) #109
Conversation
gmicol
added
enhancement
gmicol
requested review from
akinross,
anvitha-jain,
lhercot,
sajagana,
samiib and
shrsr
as code owners
github-actions
bot
changed the title
gmicol
changed the title
gmicol
force-pushed
the
nd_rest
branch
2 times, most recently
from
b5a4cdf to
1af8cb5
Compare
| - Some payloads are known not to be idempotent, so be careful when constructing payloads. | ||
| """ | ||
|
|
||
| EXAMPLES = r""" |
There was a problem hiding this comment.
Missing a PATCH example, but see examples for all the others. Should we add?
There was a problem hiding this comment.
We should, I will add it.
| nd = NDModule(module) | ||
|
|
||
| # Validate content/payload | ||
| if content and isinstance(content, str) and HAS_YAML: |
There was a problem hiding this comment.
should we also validate json data?
| - cisco.nd.modules | ||
|
|
||
| notes: | ||
| - Some payloads are known not to be idempotent, so be careful when constructing payloads. |
There was a problem hiding this comment.
should we add link reference to nd api docs and or swagger reference?
| description: | ||
| - Sets the payload of the API request directly. | ||
| - This may be convenient to template simple requests. | ||
| - For anything complex use the C(template) lookup plugin (see examples). |
There was a problem hiding this comment.
perhaps I am missing this example
There was a problem hiding this comment.
forgot to add an example for this case, will add it
| type: str | ||
| required: true | ||
| aliases: [ uri ] | ||
| content: |
There was a problem hiding this comment.
can we also provide a file path with content?
There was a problem hiding this comment.
I should add a new attribute for that
| } | ||
| } | ||
|
|
||
| - name: Query Security Domain using GET method |
There was a problem hiding this comment.
Does this module also support query strings in the path of GET requests?
Should we add some examples using parameters such as, filter, orderBy and the pagination options?
Fixes #107
Addition of a new module
nd_restto handle generic ND REST API requests.