ComboJSONAPI

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

1. Permission plugin enables access control to models and their fields in GET, POST, PATCH and DELETE methods. (Permission Plugin docs)
2. ApiSpecPlugin simplifies automated JSONAPI documentation. (ApiSpec Plugin docs)
3. RestfulPlugin for apispec library in the ApiSpecPlugin enables documenting GET parameters with Marshmallow schemas. (Restful Plugin docs)
4. EventPlugin enables RPC creation for those cases when you can't make it with pure JSON:API (Event Plugin docs).
5. PostgreSqlJSONB features filtering and sorting data by first-level key values of JSONB values in PostgreSQL (PostgreSqlJSONB Plugin docs).

Installation

pip install combojsonapi

Documentation

• https://combojsonapi.readthedocs.io/

Contributing

If you want to contribute to the code or documentation, the Contributing guide is the best place to start. If you have questions, feel free to ask

Documentation

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

License

MIT