statusfy icon indicating copy to clipboard operation
statusfy copied to clipboard

Systems: Get localized names and descriptions via API

Open maicol07 opened this issue 4 years ago • 2 comments

Feature request

  • [x] I confirm that this is a feature request rather than a question.

What problem does this feature solve?

The systems API endpoint returns ids, not localized names and descriptions

What does the proposed API look like?

See above

How should this be implemented in your opinion?

Using the localized files, add to the json files the localized names and descriptions of each system (keeping the id)

Are you willing to work on this yourself?**

No, as I don't know Vue

maicol07 avatar Jul 20 '20 12:07 maicol07

Hello @maicol07. I don't quite understand what's your feature request. Can be more clear about it? Thanks.

You may want to read this announcement first https://github.com/juliomrqz/statusfy/issues/551.

juliomrqz avatar Jul 31 '20 00:07 juliomrqz

At the moment, with 0.5 the api call to the systems endpoint is like this:

Call to https://demo.statusfy.co/static/content/api/v0/systems.en.json

Response:

[
 {
   "name": "cdn",
   "status": "partial-outage",
   "order": 1
 },
 {
   "name": "conversions",
   "status": "partial-outage",
   "order": 2
 },
 {
   "name": "site-delivery",
   "status": "operational",
   "order": 3
 },
 {
   "name": "api",
   "status": "partial-outage",
   "order": 4
 }
]

What I request is to edit this to:

 {
   "id": "cdn",
   "name": "CDN",
   "status": "partial-outage",
   "order": 1
 },
 {
   "id": "conversions",
   "name": "Conversions",
   "status": "partial-outage",
   "order": 2
 },
 {
   "id": "site-delivery",
   "name": "Site delivery",
   "status": "operational",
   "order": 3
 },
 {
   "id": "api",
   "name": "API",
   "status": "partial-outage",
   "order": 4 
 }
]

So the translated name for each system. At the moment changing the locale in the endpoint does not make any difference.

The name field would be the translated name for that system (added in locale files) while the id one would be the system id added in the config file.

maicol07 avatar Jul 31 '20 07:07 maicol07