plone.restapi
plone.restapi copied to clipboard
plone
Add portal_type title
This adds a new field type to content response which contains the title of portal_type.
Example of why this is needed:
Let's say I have a content-type named Topic page with the id topic_page. Fetching a page of this content-type will respond with:
{
'@type': 'topic_page',
...
}
There is no way to get the human readable title of the content-type so this pr will add a new field and the response will look like:
{
'@type': 'topic_page',
'type': 'Topic page',
...
}
@razvanMiu thanks for creating this Pull Request and helping to improve Plone!
TL;DR: Finish pushing changes, pass all other checks, then paste a comment:
@jenkins-plone-org please run jobs
To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically.
Happy hacking!
Deploy Preview for plone-restapi canceled.
| Name | Link |
|---|---|
| Latest commit | 9f84b0d902d94b2eeaed044d7800d17146a2a229 |
| Latest deploy log | https://app.netlify.com/sites/plone-restapi/deploys/6465495a32eeef0008d3ffce |
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
Assuming this is for Volto: A mapping from fti id to fti title can be received from state.types. No need to extend the serializers.
@ksuess Can you detail a little. Is it available for anonymous users?
So issue description has to be read as "There is no way to get the human readable title of the content-type as long the user is Anonymous"
I think it is okay to get the FTI title property delivered as well.
To overcome the processing overhead I suggest to use the dexterity FTI cache and its lookup_fti method.
As @davisagli mentioned, the naming is confusing and needs some love.
Also, I do not see any documentation added.
I would also suggest that the dozens of changes in this PR that remove a blank line be reverted and put into a separate PR. That should be handled by code quality tools.
I would also suggest that the dozens of changes in this PR that remove a blank line be reverted and put into a separate PR. That should be handled by code quality tools.
Indeed. I just ran make black and make zpretty and saw a lot of files formatted. This happens even if you do it in a fresh clone in master 🤔 .
That should be handled by code quality tools.
This package lacks of plone/meta so, this will solve it once applied here.
One thing I don't get is where to put the documentation about this extra field? Isn't it self-explanatory with being just added in http-examples?
One thing I don't get is where to put the documentation about this extra field? Isn't it self-explanatory with being just added in
http-examples?
@stevepiercy may I head this one over to you?
@jensens, I agree with @nileshgulia1. What do you think is needed in the way of documentation?
I found no place where the REST API authors have documented the keys in a response. Do they want to start?
