Closed
Bug 1209977
Opened 9 years ago
Closed 9 years ago
Propose a better json format files for the product details
Categories
(www.mozilla.org :: Product Details, defect)
Tracking
(Not tracked)
RESOLVED
FIXED
People
(Reporter: Sylvestre, Assigned: Sylvestre)
References
(Blocks 1 open bug)
Details
Attachments
(1 file)
(deleted),
text/x-github-pull-request
|
Details |
The actual json files are just providing:
version, release date
This is not enough, we need:
* provide more information like category (esr, dev, major or release), description (why we did this release), was it a chemspill?
* having a format which can evolve (adding new fields)
* having a single file for firefox, fennec, tb and all
* enable easy searchs
Instead of updating the actual files and break the web, I propose to introduce new files.
The format is pretty simple:
{
"firefox-38.0.1esr": {
"category": "esr",
"product": "firefox",
"description": "foo bar test 2000 chemspill",
"is_security_driven": true,
"version": "38.0.1",
"date": "2015-09-30"
},
"firefox-38.0.5b2": {
"category": "dev",
"product": "firefox",
"description": null,
"is_security_driven": false,
"version": "38.0.5b2",
"date": "2015-05-15"
}
}
(format suggested by Alexis Metaireau)
Assignee | ||
Comment 1•9 years ago
|
||
Assignee | ||
Updated•9 years ago
|
Assignee: nobody → sledru
Comment 2•9 years ago
|
||
json makes it easy to extend a format like this in the future. However, if we ever remove anything, we may break someone. Do we need a concept of version in here? For ex,
{
version: 1.0,
releases: {
"firefox-38.0.1esr": {
"category": "esr",
"product": "firefox",
"description": "foo bar test 2000 chemspill",
"is_security_driven": true,
"version": "38.0.1",
"date": "2015-09-30"
},
"firefox-38.0.5b2": {
"category": "dev",
"product": "firefox",
"description": null,
"is_security_driven": false,
"version": "38.0.5b2",
"date": "2015-05-15"
}
}
}
Filtering is admittedly a topic for another bug but should we support filtering products and categories (and maybe date ranges) via query params? For ex,
?product=firefox,thunderbird
?category=dev,aurora,beta,release,esr
Assignee | ||
Comment 3•9 years ago
|
||
Right, changes implemented in the updated PR:
https://github.com/mozilla/ship-it/pull/38
Assignee | ||
Comment 4•9 years ago
|
||
This is live:
https://product-details.mozilla.org/
Status: NEW → RESOLVED
Closed: 9 years ago
Resolution: --- → FIXED
You need to log in
before you can comment on or make changes to this bug.
Description
•