Skip to content

README.md

Latest commit

 

History

History
91 lines (67 loc) · 3.64 KB

README.md

File metadata and controls

91 lines (67 loc) · 3.64 KB

Consent Building Block (Govstack)

About • Release Status • Core Team • Contributing • Licensing

About

Consent BB defines the principles, functions and architecture of an information system that enables services for individuals to approve the use of her/his personal data and for information system operators that process personal data of individuals to know the will of the individual and legitimately process such personal data.

It is a process-oriented GovStack BB facilitating auditable bilateral agreement within a multi-agent environment, that integrates with most other BBs.

This repository contains the deliverables from Consent BB team, as part of the Govstack project.

Core Team

Working Group Representative: Ramkumar (psramkumar2@gmail.com)

Deliverables

The key deliverables are as summarised below:

  1. Consent BB definition 0.9.0RC2
  2. Use case specifications (see Consent BB Definition)
  3. Functional and technical requirements (see Consent BB Definition)
  4. OpenAPI specs - Latest version: 0.9.0rc1
  5. Rendered diagrams and diagram sources (maintained in Git)

Release Status

All diagrams and API specifications contained here are subject to ongoing changes by an internal GovStack Working Group, following this roadmap:

  • Wave 2, Internal Review (July 14th, 2022)
  • Release certification (Deadline TBA)
  • Limited publication (Deadline TBA)
  • Community-wide publication (~August 2022)

Contributing

Feel free to improve the plugin and send us a pull request. If you found any problems, please create an issue in this repo.

Licensing

Licensing is under GNU General Public License 3.0

Consent specs in Gitbook

Govstack specs are published at Gitbook - Govstack Global.

Note that pushes to the main branch will automatically trigger a Gitbook build and deployment from the /spec directory.

Repo Structure

README.md
/spec # the markdown files which are used to build the specification in GitBook
/api # the openapi specification
/test # the test plan and tests
  plan.md
/examples # examples for deploying, configuring, and testing applications which implement the behaviors specified by this building block
  /application-a
    README.md # instructions for deployment/testing
    docker-compose.yaml # example deployment file
      db
      web
      adaptor
      security-server
    Caddyfile # example config for "adaptor"
    Dockerfile # dockerfile to build "adaptor"
  /application-b
  /application-c