specifications: v1 history to v2 releases #3304
Conversation
Signed-off-by: Sergio Schvezov <sergio.schvezov@canonical.com>
|
|
||
| Internal migration from the Snap Store v1 history API endpoint to the | ||
| improved v2 releases endpoint which uses a /snap name/ instead of | ||
| =snap-id= as en entry point and returns a much more versatile dataset to |
|
|
||
| On output, the following changes shall be made: | ||
|
|
||
| - Acknowledge that a Snap Revision can be compromised of multiple |
There was a problem hiding this comment.
"Acknowledge" is an odd start. Given the opening, I'd suggest starting with the change(s), then provide rationale as needed. e.g. /Arch/ column renamed to /Arches/, to allow for a comma separated list as a snap revision and span multiple architectures.
| - Acknowledge that a Snap Revision can be compromised of multiple | ||
| architectures, changing the output of the table from /Arch/ to /Arches/ | ||
| and allowing for a comma separated list. | ||
| - Always displaying the full channel under /Channels/ (the history |
There was a problem hiding this comment.
nit: s/displaying/display
There is a mix of future and present tense throughout.
| and allowing for a comma separated list. | ||
| - Always displaying the full channel under /Channels/ (the history | ||
| endpoint return only <risk> for defaults). | ||
| - The /Channels/ comma separated list shall have no spaces for easier |
There was a problem hiding this comment.
nit: hypenate "comma-separated" or "comma-deliminated".
|
|
||
| * Implementation | ||
|
|
||
| The Snap Store API for [[https://dashboard.snapcraft.io/docs/v2/en/snaps.html#snap-releases][Releases]] returns two /streams/ of interest, those |
There was a problem hiding this comment.
I did, the link gets to you :-P
|
|
||
| * Implementation | ||
|
|
||
| The Snap Store API for [[https://dashboard.snapcraft.io/docs/v2/en/snaps.html#snap-releases][Releases]] returns two /streams/ of interest, those |
There was a problem hiding this comment.
s/of interest, those are.../of interest: =revisions= and =releases=.
There was a problem hiding this comment.
how about using the suggestion :-)
| * Implementation | ||
|
|
||
| The Snap Store API for [[https://dashboard.snapcraft.io/docs/v2/en/snaps.html#snap-releases][Releases]] returns two /streams/ of interest, those | ||
| are =revisions= and =releases=. These streams are ordered and relied on |
There was a problem hiding this comment.
ordered how? I don't think you need to state that it's relied on (anything in the API must be reliable).
|
|
||
| And this is how the new output shall display: | ||
|
|
||
| #+BEGIN_SRC |
There was a problem hiding this comment.
The example should probably capture all of the changes (e.g. multi-arch). And maybe used a more contrived example to keep it succinct?
There was a problem hiding this comment.
I wanted to use a real world example to not make things up and for proper verification, I guess use made up data if that is desired
|
|
||
| #+END_SRC | ||
|
|
||
| And this is how the new output shall display: |
There was a problem hiding this comment.
nit: "And this is how" is very informal.
There was a problem hiding this comment.
What is the formal suggestion?
|
|
||
| - [ ] Add bindings to Snap Store package | ||
| - [ ] Replace use of history with releases bindings for CLI | ||
| - [ ] Remove v1 history bindings |
There was a problem hiding this comment.
I imagine there'd be a todo item for changing the output format? or is that coupled with history->release bindings?
There was a problem hiding this comment.
I implied it with CLI, second item
Signed-off-by: Sergio Schvezov <sergio.schvezov@canonical.com>
Signed-off-by: Sergio Schvezov sergio.schvezov@canonical.com
./runtests.sh static?./runtests.sh tests/unit?