Comments (5)
What about a URL to the referenced object (that can be expanded)? We should also add a "parent" pointer (I think I already did that in a branch somewhere). Children are already covered by the JSON-LD "member" list, right?
from plone.restapi.
Yes, sure. I just think we should use the same format (and thus the same code) for such references, e.g.:
{
"@id": "http://nohost/plone/foo/very-important-news",
"title": "Very important news"
}
It would be great if all those pointers look the same.
from plone.restapi.
It would be great if all those pointers look the same.
Agreed, as long as we can work with a loose enough definition of "the same" 😀 I'd say "the same" in the sense that it should always be a dictionary with an @id
where the complete resource can be found, and 0 - n
metadata fields, depending on context (and possibly a client-supplied parameter like field_list
).
Because in some contexts, the 95% will be just rendering a link - so the target URL and title
might be enough. In other contexts, you'll need more of the metadata of referenced objects (search results for example must already include things like portal type and author to be useful).
from plone.restapi.
If you need a different representation of the relations we might want to create another frame to render the JSON differently.
from plone.restapi.
Summary representations have been unified in #71.
Relation fields are now serialized to a summary like this, same as parent pointers, children, search results and collection items:
{"@id": "http://nohost/plone/doc1",
"@type": "Document",
"title": "Referenceable Document",
"description": "Lorem Ipsum"
}
from plone.restapi.
Related Issues (20)
- Drop Python 3.7 support HOT 1
- jwt_auth PAS plugin is active without being installed HOT 9
- Global Site tabs should also be customizable with customize_entry HOT 5
- navigation_base_url is not also used here HOT 2
- json_body should not read entire request BODY HOT 5
- debug-exceptions = on in instance part in buildout causes requests that return BadRequest to be returned as html instead of json
- KeyError: 'portal' in tests with Python 3.12.1 HOT 10
- Translate validation error messages
- IBlocks SearchableText indexer bypasses plone.textindexer behavior HOT 2
- relatedItems field returns None in the serializer if the related item is deleted HOT 1
- Site Administrator cannot add user to group
- Add remote_url(getRemoteUrl) to link content-types in navigation HOT 4
- Include release notes in Plone 6 Documentation
- Authentication error messages from PAS Plugins aren't returned by the restapi HOT 1
- restapi double parameter is broking code. HOT 8
- In content that uses the plone.blocks behavior, it is not possible to add fields to SearchableText with "plone.app.dexterity.textindexer" HOT 6
- Community Forum App Icon Not Filling Correctly. HOT 1
- Add plone.app.discussion control panel
- Types control panel does not allow to enable/disable discussion for a content type
- Implement SummaryDiscussionListingTemplate to fix Discussion url in listings HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from plone.restapi.