README.adoc

= Bonita OpenAPI specification

image:https://github.com/bonitasoft/bonita-openapi/workflows/build/badge.svg[Actions Status, link=https://github.com/bonitasoft/bonita-openapi/actions?query=build]
image:https://img.shields.io/github/v/release/bonitasoft/bonita-openapi?color=blue&label=Release[GitHub release, link=https://github.com/bonitasoft/bonita-openapi/releases]
image:https://img.shields.io/badge/License-GPL%20v2-blue.svg[GPLv2 License, link=LICENSE]

This project is about describing the Bonita web API in https://swagger.io/specification/[Open API v3] format.

This single yaml file is to become the single source of truth for the Bonita features accessible through HTTP.

Based on this file, one could generate : documentation, client in different language and/or technology, server side stubs, ...

== Open API v3

The specification file is written in `yaml` format because multiline support is much better than in `json`
The specification has a lot of _description block_ and since it is a _documentation_, it needs to be quite verbose.

The specification file can be found here: `openapi/openapi.yaml`

We make use of https://swagger.io/docs/specification/openapi-extensions/[extensions] to add better support for some documentation sites (x-logo, x-codeSamples, ...)

This repository structure was inspired by https://github.com/Redocly/create-openapi-repo.

== Live Documentation

The api descriptor file can be used to render documentation sites. Those sites have different rendering and may show different parts of the specification file.
That's the reason why it is interessting to test and evaluate differents sites and rendering.

You 'll need to install the https://github.com/redocly/openapi-cli[openapi-cli] to be able to work on the specification.

=== Redoc Preview

A https://github.com/Redocly/redoc[ReDoc] site is available at http://localhost:8080 when you run from project directory

[source,bash]
----
npm start
----

This preview is the preferred one when editing the specification.

=== Swagger Preview

The `docker-compose.yaml` file at the project root starts two sites: a https://swagger.io/tools/swagger-ui/[swagger-ui] site and a Bonita instance to query

To start the container, just issue the following comment at the project root:

[source,bash]
----
docker-compose up -d
----

You should be able to access:

- Bonita: http://bonita.localhost/bonita
- Swagger UI: http://swagger.localhost

NOTE: You can keep on editing the specification file and just refresh the browser to see the changes.

== Links

*Open API documentation:*

https://swagger.io/docs/specification/basic-structure/

*IDE support:*

- intellij: https://www.jetbrains.com/help/idea/openapi.html
- eclipse: https://marketplace.eclipse.org/category/free-tagging/openapi

*Specification samples:*

- Docker API: https://docs.docker.com/engine/api/v1.40/
- Discourse API: https://docs.discourse.org/
- API hub: https://apis.guru/browse-apis/
- Samples: https://github.com/OAI/OpenAPI-Specification/tree/master/examples/v3.0

*ReDoc*

- https://github.com/Redocly/redoc

== Create a release

A GitHub action is used to automate the link:.github/workflows/release.yml[release workflow].
The workflow is triggered when pushing a branch with the following pattern `release/<version>`.
The `version` should match the `info.version` attribute in link:openapi/openapi.yaml[] file.

A GitHub release is created with the `yaml` specification file and the `json` postman collection attached.
Release note must be filled manually.

== How to contribute

We would love you to contribute, pull requests are welcome! 
Have a look to link:DEV.md[] guidelines and don't forget to sign our Contributor Licensing Agreements when opening a pull request.
This repository uses https://guides.github.com/introduction/flow/[Github flow], so pull requests should target the `master` branch.