Add proposal for version 3.0 of the pylxd API #283
Conversation
This is a proposal/spec to explain what a v3 of the pylxd API would be like and why it is needed. This would be a breaking change for clients of pylxd.
notes/version-3-proposal.rst
Outdated
|
|
||
| 2. The attribute system only tries to do a single level of JSON loading, and | ||
| doesn't load the whole tree of metadata returned in an API call. Thus you | ||
| get the (slightly) perverse situation of some attributes container JSON |
There was a problem hiding this comment.
should this read: some attributes contain JSON?
There was a problem hiding this comment.
Yes, it should. Thanks for the catch.
notes/version-3-proposal.rst
Outdated
|
|
||
| .. code-block:: python | ||
|
|
||
| container = c.profiles['default'].used_by |
There was a problem hiding this comment.
Should this be containers?
There was a problem hiding this comment.
IIRC, c at this point is a container object, and thus this would be correct. I'll check though.
There was a problem hiding this comment.
I understand, and concur, that c is a container; I'm concerned that, on asking for the profile, that we would not then have the list of containers using that profile (ex: default has many containers)
There was a problem hiding this comment.
I think what I may not have explained well is that used_by would be a ContainerManager instance, meaning that it represents 0..n containers. I'll change the initial variable assignment to container_manager and add some words.
notes/version-3-proposal.rst
Outdated
| container = c.profiles['default'].used_by | ||
| <... Manager for containers ...> | ||
|
|
||
| i.e. the ``used_by`` property would return a manager to access profiles. |
There was a problem hiding this comment.
I believe that this manager would access containers?
There was a problem hiding this comment.
And, yes, this is true too.
Codecov Report
@@ Coverage Diff @@
## master #283 +/- ##
=======================================
Coverage 97.25% 97.25%
=======================================
Files 11 11
Lines 728 728
Branches 84 84
=======================================
Hits 708 708
Misses 6 6
Partials 14 14Continue to review full report at Codecov.
|
This is a proposal/spec to explain what a v3 of the pylxd API would be
like and why it is needed. This would be a breaking change for clients
of pylxd.
It's opened for discussion here; thoughts both for and against are welcomed.