Versions¶
A Version
is a specific iteration of a Product
.
List¶
GET /api/versions/ HTTP/1.1
HTTP/1.1 200 OK
[
{
"id": "XG4pVvD",
"product": "ZPweolo",
"label": "0.2.0",
"description": "This is a description of the product version.",
"created_at": "2019-04-02T20:07:33.117295Z",
"primary_plan": {
"id": "g45z7wA",
"title": "Full Install",
"version": "XG4pVvD",
"preflight_message": "<p>Preflight message.</p>",
"tier": "primary",
"slug": "full-install",
"old_slugs": [],
"steps": [],
"is_allowed": true,
"is_listed": true,
"not_allowed_instructions": null,
"requires_preflight": true
},
"secondary_plan": null,
"is_listed": true
},
...
]
Retrieve¶
GET /api/versions/XG4pVvD/ HTTP/1.1
HTTP/1.1 200 OK
{
"id": "XG4pVvD",
"product": "ZPweolo",
"label": "0.2.0",
"description": "This is a description of the product version.",
"created_at": "2019-04-02T20:07:33.117295Z",
"primary_plan": {
"id": "g45z7wA",
"title": "Full Install",
"version": "XG4pVvD",
"preflight_message": "<p>Preflight message.</p>",
"tier": "primary",
"slug": "full-install",
"old_slugs": [],
"steps": [],
"is_allowed": true,
"is_listed": true,
"not_allowed_instructions": null,
"requires_preflight": true
},
"secondary_plan": null,
"is_listed": true
}
Create¶
POST /api/versions/ HTTP/1.1
{
"product": "ZPweolo",
"label": "0.2.0",
"description": "This is a description of the product version.",
"primary_plan": "g45z7wA",
"secondary_plan": null,
"is_listed": true
}
HTTP/1.1 201 CREATED
Update¶
PATCH /api/versions/XG4pVvD/ HTTP/1.1
{
"description": "This is a new description of the product version.",
}
HTTP/1.1 200 OK
{
"id": "XG4pVvD",
"product": "ZPweolo",
"label": "0.2.0",
"description": "This is a new description of the product version.",
"created_at": "2019-04-02T20:07:33.117295Z",
"primary_plan": {
"id": "g45z7wA",
"title": "Full Install",
"version": "XG4pVvD",
"preflight_message": "<p>Preflight message.</p>",
"tier": "primary",
"slug": "full-install",
"old_slugs": [],
"steps": [],
"is_allowed": true,
"is_listed": true,
"not_allowed_instructions": null,
"requires_preflight": true
},
"secondary_plan": null,
"is_listed": true
}