Decidim Rest Api

This repository contains a Rails Engine describe a RestAPI for Decidim. This works is still a work on progress (started end-2024).

Documentation

The documentation and the API specification are in the documentation website

Resources supported

• Organizations
• Taxonomies
• User authentification
• User Impersonation
• User Groups
• Proposals
• Vote on proposals
• Meetings
• Newsletters
• Articles
• Official Meetings
• Menu and navigation
• Term Customizers

Scripts

yarn docs:start
Start a docusaurus website

yarn docs:update
Generates again the openapi spec, add it to docusaurus, and compile again.

Run tests

You can run tests on the same image used by the pipeline, to be confident to push:

docker compose  -f docker-compose.yml -f docker-compose.test.yml up

Update Versions

Release a version is up to the maintainer of this repo.

The main package.json version attribute is dispatch on versionning the ruby engine, allowing to bump the multi-repo with unique version.

To run these scripts, change your current branch to main and do:

Release a patch

yarn version --new-version patch --no-git-tag-version
yarn postversion
git add .
git tag v0.0.<yourpatch>

Release a minor

yarn version minor
yarn postversion
git add .
git tag $(yarn postversion)

Publish clients

The gem rswag generate a valid openapi spec, that then is used to generate node clients. We can publish these clients:

node-client

• yarn gen:node-client: sync the open-api spec with existing rswag test, and call openapi-generators
• cd contrib/decidim-node-client && yarn publish