ComboJSONAPI: Plugins to improve functionality of the Flask-COMBO-JSONAPI

ComboJSONAPI is a set of plugins made for Flask-COMBO-JSONAPI.

1. Permission plugin enables access control to models and their fields in GET, POST, PATCH and DELETE methods.

2. ApiSpecPlugin simplifies automated JSONAPI documentation.

3. RestfulPlugin for apispec library in the ApiSpecPlugin enables documenting GET parameters with Marshmallow schemas.

4. EventPlugin enables RPC creation for those cases when you can’t make it with pure JSON:API.

5. PostgreSqlJSONB features filtering and sorting data by first-level key values of JSONB values in PostgreSQL.

Contents

• Installation
• Example
• Classical CRUD operations
  • Create object
  • Get object
  • Get objects
  • Sparse fields
• Relationships
  • Create computer
  • Update person’s attributes and relationships in one request
  • Get computers with owners (person relationship) and select fields at the same time
• Events Example
• Classical CRUD operations
  • Create user object
  • Get custom event info
  • Post custom event info
  • Update user’s avatar
• Event Plugin
  • How to use
    • How plugin works
    • How to describe a view
  • Plugin extra params
  • Plugin usage example
• Permission plugin
  • How to use
    • PermissionMixin class API
    • Resource Manager Descriptions
  • Usage example
    • Example of loading various object attributes depending on the address at which the object was requested
• ApiSpec plugin
  • How to use
• Restful plugin
• PostgreSqlJSONB plugin
  • How to use
  • Plugin usage example
  • Requests example
• Using Plugins
  • Attaching Plugins
  • Plugins API
  • Making a New Plugin Example

• Changelog
  • 1.1.2
  • Bug Fixes
  • 1.1.1
  • Bug Fixes
  • 1.1.0
  • Enhancements
  • 1.0.5
  • Bug Fixes
  • 1.0.3
  • Enhancements
  • 1.0.0
  • Changes
  • 0.1.1
  • Enhancements
  • Bug Fixes
  • 0.1.0
  • Enhancements

Documentation

• https://combojsonapi.readthedocs.io/

To update docs:

# go to docs dir
cd docs
# gen .pot files
make gettext
# update .po files for existing langs / create new
sphinx-intl update -p _build/locale -l ru

• add new langs via additional flag “-l es”

• add translations to docs/locale/<lang>/LC_MESSAGES

• to check your translations run sphinx-build -b html -D language=ru . _build/html/ru and check generated HTML files