Package: imio.restapi
imio.restapiplone.restapi endpoints and adaptationsFeaturesadd element:with childrentrigger WF transitions@pod-templatesendpoint (collective.documentgenerator)disable returning fullobject serialization upon creation:by default when an object is created, the fullobject serialization is returned which is doing some processing sometimes unnecessaryadding an environment variableRETURN_FULLOBJECT_AFTER_CREATION_DEFAULT Falsewill return the summary serialization when an object is createdthis will change the default behavior but it is still possible to change this behavior for a particular POST by defining the"return_fullobject": true/falsein the BodyTodomanage wf_transitions triggered when creating an element in the deserializer when we will be using only DXinclude cleanHTML functionnality at the deserializer level, also when we will be using only DXInstallationInstall imio.restapi by adding it to your buildout:[buildout]

...

eggs =
    imio.restapiand then runningbin/buildoutContributeIssue Tracker:https://github.com/collective/imio.restapi/issuesSource Code:https://github.com/collective/imio.restapiDocumentation:https://docs.plone.org/foo/barLicenseThe project is licensed under the GPLv2.ContributorsMartin Peeters [Affinitic], Original authorChangelog1.0b3 (2023-08-25)Added parameterdebug_modeto the settings, when enabled, input and output
requests are displayed into the Zope log.
[gbastien]1.0b2 (2023-05-31)Added helperutils.serialize_termthat will serialize a vocabulary term
the same way it is done by theFieldSerializer.
[gbastien]1.0b1 (2022-01-03)InFolderPost.do_replyif an error occurs, do not continue,
stop and return the result with the error immediately.
[gbastien]Addedreturn_fullobject_after_creation_default,Trueby default,
to theimio.restapisettings panel. This will do the full serialized object to
be returned after an object is created (this is already the current behavior).
When set to False, the summary serialization will be returned.
[gbastien]Fixed@infos?include_stats=1blobstorage size computation to use.size.json.
[gbastien]1.0a15 (2021-11-08)Override ‘update’ and ‘workflow transition’ to use the uid
[vpiret]1.0a14 (2021-07-16)Avoid duplicates inmetadata_fields.
[gbastien]In@infosifPWDenv variable is not available, try to determinate instance
path using theINSTANCE_HOMEenv variable.
[gbastien]Requireplone.restapi<8insetup.pyas versions 8+ are only for Python3.
[gbastien]Fixed tests due to changes incollective.documentgeneratorwhere
theConfigurablePODTemplatenamedtest_ods_templateis no more generable
on typeDocument.
[gbastien]Added possibility to redefine the name of themetadata_fieldsform parameter
so it may be overrided by a subclass for example.
[gbastien]1.0a13 (2021-02-15)Cleanupbase_search_uidparameter to avoid warnings in instance logs
[mpeeters]Adapt@searchservice to use the context instead of usingpathindex that can be buggy on some circumstances
[mpeeters]1.0a12 (2021-02-03)Improve@searchby allowing element UID other than Collection forbase_search_uidparameter that can be used as a base path
[mpeeters]Moved management of additionalmetadata_fieldsfrom theSearchGetservice
to theDefaultJSONSummarySerializercreated for that, it will override
the defaultplone.restapiDefaultJSONSummarySerializerand addidandUIDby default to the results.
[gbastien]1.0a11 (2020-09-10)LeaveFolderPost._after_reply_hookempty (was managingwf_transitions)
orwf_transitionscould be broken if a package overrides_after_reply_hookand forget to call super’s original method
[gbastien]1.0a10 (2020-06-28)Add class on list of actions
[mpeeters]1.0a9 (2020-06-24)Improve caching of REST vocabularies
[mpeeters]Displayimio-restapi-actionsandimio-restapi-linksviewlets
only when package is installed (IImioRestapiLayer)
[gbastien]1.0a8 (2020-06-23)Improve filtering for remote rest vocabulary by using the id without the domain
[mpeeters]Use@relative_pathattribute for links
[mpeeters]Implement base serializer to add@relative_pathattribute
[mpeeters]1.0a7 (2020-06-23)Fix an issue with search vocabulary term ids whenb_sizeparameter is used
[mpeeters]1.0a6 (2020-06-23)Fix permissions for viewlet
[mpeeters]1.0a5 (2020-06-23)Fix an error with vocabulary request when there is no body
[mpeeters]1.0a4 (2020-06-22)Add missing french translations
[mpeeters]Implement basic auth adapter for requests
[mpeeters]Add an adapter to allow data transform during import of content
[mpeeters]Ensure that REST vocabulary base class have context available
[mpeeters]Add@uidrest service
[mpeeters]AddImportFormbase class for content import from remote app
[mpeeters]Make_request_schemaoptional to handle more usecases
[mpeeters]Addimport_contentutils to create content from rest call result
[mpeeters]Addget_application_urland improvegenerate_request_parametersutils
[mpeeters]Implement a base class vocabulary for search of objects on remote app
[mpeeters]Removeclient_idparameter from base vocabulary class since the value is set directly on zope config
[mpeeters]Add caching for vocabularies
[mpeeters]Update translations
[mpeeters]Update form implementation for links
[mpeeters]Improve link viewlet
[mpeeters]Implement services for REST links
[mpeeters]Add a serializer for links
[mpeeters]Renamed@pod endpointto@pod-templatesto be more explicit.
Endpoint@pod-templatesis now a default exapandable element
available in@components.
[gbastien]MovedFolderPost.wf_transitionscall intoFolderPost._after_reply_hook.
Updateserialized_objreview_statekey if transitions were triggered inFolderPost.wf_transitions.
[gbastien]Added endpoint@infosto get various informations about application.
This is soft depending onProducts.CPUtilsandimio.pyutils.
[gbastien]Requireplone.restapi>=6.13.3.
[gbastien]Override@searchdefault endpoint so it is easier to complete and
is a base for sub-packages.
Added management ofbase_search_uid, being able to give aCollection UIDas base query.
[gbastien]1.0a3 (2020-06-08)Addrequeststo package dependencies
[mpeeters]Inadd.FolderPost.reply, callself.__class__insteadFolderPostto managechildrenin case we inherit fromFolderPost.
[gbastien]Addedadd.FolderPost.prepare_datato be able to prepare data
before callingreplythat will create the element.
By default, this checks that data for file is correct.
[gbastien]Added hook afterreply(_after_reply_hook).
[gbastien]If keywf_transitionsis found during creation,
given WF transitions are triggered.
[gbastien]Added@warningsmanagement inFolderPost.
[gbastien]1.0a2 (2020-01-10)Add REST links
[mpeeters]Add REST actions
[mpeeters]Add a base form class for REST interaction
[mpeeters]Implement a converter from json schema to a z3c.form interface
[mpeeters]Implement an endpoint to return a json schema schema
[mpeeters]Implement control panel
[mpeeters]Addbulkendpoint
[mpeeters]Add a endpoint to get Archetypes vocabulary values
[mpeeters]Add package tests
[mpeeters]Add@podendpoint that will return everycollective.documentgeneratorgenerable POD template for a context.
This include information on the POD template and links to generate the final
document in available output formats.
[gbastien]1.0a1 (2018-12-04)Initial release.
[mpeeters]