Use 'value' attribute in objects to locate object path in etcd #9
Conversation
|
@nthomas-redhat @r0h4n please review. |
| object path is the plural of the object name etc. The assumption might not | ||
| always be correct and hence the paths for retrieving single instance or a list | ||
| of the objects should be picked up from the definitions yaml files under the | ||
| object section with a attribute defined as 'value'. |
| == Proposed change | ||
|
|
||
| Tendrl API should use the configuration defined under objects 'value' in the | ||
| defitnitions yaml file to locate the path for specific object. The path should |
There was a problem hiding this comment.
@anivargi above spelling mistake ^^
|
|
||
| ==== Tendrl API impact: | ||
|
|
||
| The proposed change is a internal change and will not affect existing API's. |
|
|
||
| === Work Items: | ||
|
|
||
| https://github.com/Tendrl/tendrl-api/issues/28 |
There was a problem hiding this comment.
We need to put github PR details here
There was a problem hiding this comment.
Github issues are to be linked here, not PRs, PRs will come after the spec is approved
|
|
||
| ==== Tendrl/node_agent impact: | ||
|
|
||
| None |
There was a problem hiding this comment.
node agent definitions need to be updated to have "value" for each object
|
|
||
| The proposed change is a internal change and will not affect existing API's. | ||
|
|
||
| ==== Tendrl/common impact: |
There was a problem hiding this comment.
definitions validation needs to check for "value" key for each object
|
|
||
| None | ||
|
|
||
| ==== Sds integration impact: |
There was a problem hiding this comment.
sds integrations definitions need to be updated to have "value" for each object
|
|
||
| === Work Items: | ||
|
|
||
| https://github.com/Tendrl/tendrl-api/issues/28 |
There was a problem hiding this comment.
Github issues are to be linked here, not PRs, PRs will come after the spec is approved
|
|
||
| Tendrl API should use the 'value' attribute defined in the definitions yaml | ||
| files to infer the path of the object in etcd. These paths are used to retrieve | ||
| a single instance or a list of the defined object. |
There was a problem hiding this comment.
"value" will point to a single instance of the object, and "list" will point to the list of instances of those object (see: #13)
|
@anivargi Please check review comments |
|
|
||
| == Proposed change | ||
|
|
||
| Tendrl API should use the configuration defined under objects 'value' in the |
There was a problem hiding this comment.
what are the possible content of 'value' attribute? Its good to provide a sample here
|
|
||
| None | ||
|
|
||
|
|
There was a problem hiding this comment.
impact on tendrl definitions needs to be mentioned here and probably the details about the changes
|
|
||
| === Work Items: | ||
|
|
||
| https://github.com/Tendrl/tendrl-api/issues/28 |
There was a problem hiding this comment.
This need to go into the references section
| None | ||
|
|
||
| == References: | ||
|
|
There was a problem hiding this comment.
Need to create issues on the all the components involved and list them here
|
@nthomas-redhat @shtripat @r0h4n I have made the requested changes. |
Tendrl API should use the configuration defined under objects 'value' in the
definitions yaml file to locate the path for specific object. The path should
be used to retrieve a single instance.