README.rst

imio.restapi

plone.restapi endpoints and adaptations

Features

• add element:

  • with children
  • trigger WF transitions

• @pod-templates endpoint (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 unnecessary
  • adding an environment variable RETURN_FULLOBJECT_AFTER_CREATION_DEFAULT False will return the summary serialization when an object is created
  • this will change the default behavior but it is still possible to change this behavior for a particular POST by defining the "return_fullobject": true/false in the Body

Todo

• manage wf_transitions triggered when creating an element in the deserializer when we will be using only DX
• include cleanHTML functionnality at the deserializer level, also when we will be using only DX

Installation

Install imio.restapi by adding it to your buildout:

[buildout]

...

eggs =
    imio.restapi

and then running bin/buildout

Contribute

• Issue Tracker: https://github.com/collective/imio.restapi/issues
• Source Code: https://github.com/collective/imio.restapi
• Documentation: https://docs.plone.org/foo/bar

License

The project is licensed under the GPLv2.