Question #1376
closed
Added by Bernhard Koschiček-Krombholz over 3 years ago.
Updated over 3 years ago.
Description
To optimize the time to first byte received a new parameter will be introduced: ?view=
Possible options:
- detailed - is the standard, shows everything
- map - ID, Name, Class_code, Description, GIS-data
- simple - ID, Name, Class_code
- linked - ID, Name, Class_code, Relations, Types
- literals - ID, Name, Description, Aliases, ...
looks good, if it's no bother, maybe the simple view could also include aliases and desription (basically all "literals" directly connected to the entity in question) thank you!
- Description updated (diff)
I added "literals", I don't know what you mean by all literals. Can you explain further?
- Status changed from New to Acknowledged
You can now completely select everything with the parameter show . The question is, are these ?view options useful? Let's discuss it at the next dev meeting.
... yes they are! so far I am using literals and map, and they reduce TTFB as well as payload
by all literals I meant all purely string based values, that do not require resolving another entity
can you elaborate what is the parameter show - will it replace the parameter view?
https://redmine.craws.net/projects/uni/wiki/Usage#ShowHide-Types
with the parameter show , you can say, what json keys will not be displayed (and also not requested -> faster load). So if you try /api/0.1/class/E18?show=none you will just get the bare results (@id, crmClass, type, description and properties{title}) and nothing else. And with show you can select which key you want to request ('when', 'types', 'relations', 'names', 'links', 'geometry', 'depictions', 'geonames').
So the view parameter would just be a shortcut version.
... ein klassischer Fall von RTFM. Vielen Dank :)
I think I will close this, because it is not needed anymore???
yes, thank you Bernhard, I suppose for now we have all we need :)
- Status changed from Acknowledged to Closed
- Target version deleted (
208)
Also available in: Atom
PDF