REST API does not return valid JSON

[ctmbl]

Hi,
I'm new to the Sirius Web ecosystem but I've been closely watching the recent added features.

In particular since v2025.1.0 and #4020 partial support for a REST API has been added.
However I was wondering if it was intentional that some endpoints (at the very least /api/rest/projects) does not return valid JSON format?

In my case:

$ python -c 'import requests; print(requests.get("http://localhost:8080/api/rest/projects").json())'
[{'@id': '6ea46518-424f-4b88-bbc1-1afc2887d587', '@type': 'Project', 'created': '1970-01-01T00:00:00Z', 'defaultBranch': {'@id': '6ea46518-424f-4b88-bbc1-1afc2887d587'}, 'description': None, 'name': 'domain'}, {'@id': 'db78b936-faee-46af-9dc0-7490fee8938e', '@type': 'Project', 'created': '1970-01-01T00:00:00Z', 'defaultBranch': {'@id': 'db78b936-faee-46af-9dc0-7490fee8938e'}, 'description': None, 'name': 'model instance'}, {'@id': 'fe9ff9f0-8ef1-49c2-908a-0e1d49b7ea41', '@type': 'Project', 'created': '1970-01-01T00:00:00Z', 'defaultBranch': {'@id': 'fe9ff9f0-8ef1-49c2-908a-0e1d49b7ea41'}, 'description': None, 'name': 'Papaya - Example'}, {'@id': '65feb3d7-dc4e-4980-90d0-20361b3cb841', '@type': 'Project', 'created': '1970-01-01T00:00:00Z', 'defaultBranch': {'@id': '65feb3d7-dc4e-4980-90d0-20361b3cb841'}, 'description': None, 'name': 'Papaya - Blank'}, {'@id': '645cea0e-ec35-4348-891d-e87df9773b27', '@type': 'Project', 'created': '1970-01-01T00:00:00Z', 'defaultBranch': {'@id': '645cea0e-ec35-4348-891d-e87df9773b27'}, 'description': None, 'name': 'Studio'}, {'@id': '1222de5a-f9fc-48ca-ae50-1ce791eebb9e', '@type': 'Project', 'created': '1970-01-01T00:00:00Z', 'defaultBranch': {'@id': '1222de5a-f9fc-48ca-ae50-1ce791eebb9e'}, 'description': None, 'name': 'Flow'}]

More precisely what is problematic:

• the use of single quote instead of double
• the unquoted value None in case a project has no description

https://jsonformatter.curiousconcept.com/#

Let me know if you want me to create an issue 🙂

In any case, thanks in advance for your help!

[AxelRICHARD]

Hello,

Thank you for the feedback on the REST APIs, it is much appreciated.

Here are my answers:

1. the use of single quote instead of double

Could it be possible that it is your import requests; print(requests.get("http://localhost:8080/api/rest/projects").json() that produces the simple quotes?
With postman, I get double quotes.

2. the unquoted value None in case a project has no description

Could it be possible that it is your import requests; print(requests.get("http://localhost:8080/api/rest/projects").json() that produces this None value?
With postman, I get null instead of "None".

Regards,

[ctmbl]

Hello,
Thanks for the quick reply!

Could it be possible that it is your import requests; print(requests.get("http://localhost:8080/api/rest/projects").json() that produces the simple quotes?

Indeed it was the source of both behaviours, I just learnt that the .json() parses the JSON to output it in a python-compatible format (hence the None which is python's null)😅
Sorry for the bad report!

[ctmbl]

Also, is the Swagger implementation complete? I'm surely missing something but when I visit http://localhost:8080/swagger-ui/index.html#/
I get:

Surely there is some URL to enter in the search bar to get the Sirius Web API doc but I can't figure out which one 😕

[AxelRICHARD]

You're right, thank you for raising this problem. An issue has been raised (#4398), along with a pull request(#4399).

Regards,

[ctmbl]

@AxelRICHARD
Sorry to get back on this closed issue, but I think I found another strange return of the API (this time confirmed by 2 mechanisms).

On the endpoint http://localhost:8080/api/rest/projects/6ea46518-424f-4b88-bbc1-1afc2887d587/commits/6ea46518-424f-4b88-bbc1-1afc2887d587/changes introduced by #4193, each item has a payload key without any value attached.

[AxelRICHARD]

Hello,

This payload contains data specific to your metamodel.
You should implement your own version of IRestDataVersionPayloadSerializerService.java to serialize it as you want.
An example is available in SysON, a Sirius Web-based open source project.

Regards,

[ctmbl]

Hello,

Thanks for the explanation!

Does this mean this payload will stay as-is if the meta-model is defined from a Sirius Web Studio, and so without any custom Java code?
Also, out of curiosity, why not defined it as "payload": null in such cases so that the endpoint returns valid JSON format?

In any case thanks a lot for your answers and help 🙂

[AxelRICHARD]

Hello,

Does this mean this payload will stay as-is if the meta-model is defined from a Sirius Web Studio, and so without any custom Java code?

Yes

Also, out of curiosity, why not defined it as "payload": null in such cases so that the endpoint returns valid JSON format?

You're right, we probably should provide a default behavior in order to produce a valid JSON format.

Regards,

[ctmbl]

Would you like me to create an issue for that?

[AxelRICHARD]

Yes please