Using an URL to reference the item is not really convenient from a developer point a view as one wouldn't pass the URL and the UUID across its app. So, one should re-build the entry's URL where one wants to make an API call. We may solve this by replacing the hyperlink with uuid.
The field is not explicit inside the serializer / schema / docs. We may add a suffix where url or uuid is used (e.g. item_url or item_uuid, analysis_url or analysis_uuid). We may also add a help text in the schema for the docs.
I'm trying to create an analysis track and I've seen that in order to create it, I need to provide an analysis and an item as seen here : https://timeside.ircam.fr/api/docs/#operation/createAnalysisTrack.
If I provide the UUID for the analysis and the item in the request I get an "Invalid hyper - No URL match" error
If I provide the URL instead of the UUID in the JSON body, it works
This usage has two issues IMO:
Using an URL to reference the item is not really convenient from a developer point a view as one wouldn't pass the URL and the UUID across its app. So, one should re-build the entry's URL where one wants to make an API call. We may solve this by replacing the hyperlink with uuid.
The field is not explicit inside the serializer / schema / docs. We may add a suffix where url or uuid is used (e.g.
item_url
oritem_uuid
,analysis_url
oranalysis_uuid
). We may also add a help text in the schema for the docs.What's your thoughts ?