https://github.com/protegeproject/webprotege-backend-api
The API for the backend monolith
https://github.com/protegeproject/webprotege-backend-api
webprotege webprotege-api webprotege-library
Last synced: 5 months ago
JSON representation
The API for the backend monolith
- Host: GitHub
- URL: https://github.com/protegeproject/webprotege-backend-api
- Owner: protegeproject
- Created: 2021-08-07T15:14:56.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-10-08T00:08:43.000Z (8 months ago)
- Last Synced: 2025-10-08T02:31:12.403Z (8 months ago)
- Topics: webprotege, webprotege-api, webprotege-library
- Language: Java
- Homepage:
- Size: 1.4 MB
- Stars: 3
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# webprotege-backend-api
The API for the backend monolith. This will gradually shrink and eventually be phased out as we transition to microservices at the appropriate level of granularity.
## Adding New Functionality
In general, new Java interfaces, records, and classes should not be added to this library. New API interfaces should reside directly in the appropriate calling and handling microservices.
## Fixing Bugs
We use [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow) for making changes to this library. To fix bugs in this library, follow these steps:
1. Create a branch off `main`.
2. Make changes in this branch.
3. Create a pull request to merge the changes into `main`.
Changes will be reviewed and merged by one of the maintainers.
## Auto-Versioning and Auto-Release
We use a GitHub workflow to manage versioning and releases. Developers should not set version numbers manually.
When pull requests are merged into the `main` branch, the version will be automatically bumped based on the content of the pull request:
- If the pull request contains the word "breaking," the version will be bumped by a major number (e.g., 1.2.3 to 2.0.0).
- If the pull request contains the word "Feat" or "Feature," the version will be bumped by a minor number (e.g., 1.2.3 to 1.3.0).
- For all other pull requests, the version will be bumped by a patch number (e.g., 1.2.3 to 1.2.4).
After the version has been bumped, the library will be built, automatically deployed to Maven Central, and a GitHub release will be created.