Skip to content

Releases: opendevstack/ods-api-service

v0.0.1

02 Dec 15:42
@github-actions github-actions
v0.0.1
cb08f8d

Choose a tag to compare

View all tags
v0.0.1 Latest
Latest

Changelog

All notable changes to the DevStack API Service project will be documented in this file.

The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.

[0.0.1-SNAPSHOT] - 2025-11-27

Added

Core Features

  • Spring Boot 3.5.7 based REST API service for managing DevStack project lifecycles
  • Java 21 support with Maven multi-module architecture
  • OpenAPI/Swagger documentation and code generation
  • OAuth2 Resource Server authentication and authorization
  • Spring Boot Actuator for monitoring and management endpoints
  • OpenTelemetry instrumentation for distributed tracing and observability

API Modules

Project Platform API (api-project-platform)
  • REST endpoints for managing project platform information
  • Get platform information for projects (GET /api/v1/projects/{projectKey}/platforms)
  • Returns disabled platforms and categorized platform links
  • OpenAPI specification: api-project-platform.yaml
Project Users API (api-project-users)
  • REST endpoints for managing project users and roles
  • Trigger membership requests (POST /api/v1/project/{projectKey}/users)
  • Retrieve user information by username (GET /api/v1/projects/{projectKey}/users/{username})
  • Get all users in a project (GET /api/v1/project/{projectKey}/users)
  • Revoke user access from projects (DELETE /api/v1/project/{projectKey}/users/{username})
  • OpenAPI specification: api-project-users.yaml

External Service Integrations

Ansible Automation Platform (AAP) (external-service-aap)
  • Integration with Ansible Automation Platform
  • Workflow automation capabilities
OpenShift Container Platform (OCP) (external-service-ocp)
  • OpenShift/Kubernetes cluster integration
  • Project and resource management on OpenShift
  • Comprehensive documentation in /doc/external-service-ocp/
Bitbucket (external-service-bitbucket)
  • Bitbucket API v89 integration
  • Source code repository management
  • OpenAPI client generated from openapi-bitbucket-v89.yaml
UIPath (external-service-uipath)
  • UIPath RPA platform integration
  • Process automation capabilities
Webhook Proxy (external-service-webhookproxy)
  • Webhook proxy service integration
  • Event-driven architecture support
  • Documentation in /doc/external-service-webhookproxy/
Projects Info Service (external-service-projects-info-service)
  • Project information retrieval service
  • Centralized project metadata management

Build & Deployment

Multi-Build Support
  • Standard JAR Build: Traditional Spring Boot executable JAR
  • GraalVM Native Binary: Fast startup, low memory footprint native compilation
  • Docker Images: Both standard and native Docker image builds
  • Makefile: Comprehensive build automation with targets:
    • make jar - Build Spring Boot JAR
    • make native - Build GraalVM native binary
    • make docker-native - Build native Docker image
    • make quick-start - Build and run immediately
    • make all - Build everything
CI/CD Pipeline
  • GitHub Actions workflow: release-latest.yml
    • Automated builds on push to master branch
    • Sequential job execution with workspace sharing via artifacts
    • Automatic Docker image build and push
    • Latest release creation with artifacts
    • Supports both PR and manual workflow dispatch

Development Tools

  • Maven Wrapper included (mvnw / mvnw.cmd)
  • JaCoCo code coverage reporting
  • SpotBugs static analysis integration
  • Spring Java Format code formatting
  • Surefire test reporting

Documentation

  • Comprehensive README.md with:
    • Prerequisites and setup instructions
    • Build options and usage examples
    • Development workflow guides
    • Docker support documentation
    • Troubleshooting section
  • Module-specific documentation in /doc/ directory
  • OpenAPI specifications for all API modules

Configuration

  • Externalized configuration via application.yaml
  • Spring profiles support
  • Environment-based configuration management

Security

  • OAuth2 Resource Server configuration
  • CORS support
  • Spring Security integration
  • SSL/TLS configuration support

Technical Stack

Frameworks & Libraries

  • Spring Boot: 3.5.7
  • Spring Security: OAuth2 Resource Server
  • SpringDoc OpenAPI: 2.8.13
  • OpenTelemetry: 2.20.1
  • Lombok: 1.18.42
  • Jackson Databind Nullable: 0.2.7

Build Tools

  • Maven: 3.x
  • GraalVM Native Build Tools: 0.11.1
  • OpenAPI Generator Maven Plugin: 7.15.0
  • Git Commit ID Plugin: 4.9.10

Testing & Quality

  • JUnit 5: Spring Boot Test
  • JaCoCo: 0.8.13
  • SpotBugs: 4.9.6
  • Maven Surefire: 3.5.4

Infrastructure

  • Java Runtime: Java 21
  • Container Support: Docker with native image option
  • Target Platforms: Linux, macOS, Windows (via Maven wrapper)

Release Notes

This is the initial release of the DevStack API Service - a stateless, microservices-based platform for managing DevStack project lifecycles. The service provides RESTful APIs for third-party applications and CLI tools, with minimal server-side data storage and integration with external identity providers.

Key Highlights

  • ✅ Production-ready Spring Boot 3.5.7 application
  • ✅ Complete API documentation with OpenAPI/Swagger
  • ✅ Multiple deployment options (JAR, Native Binary, Docker)
  • ✅ Comprehensive external service integrations
  • ✅ CI/CD pipeline with automated releases
  • ✅ Observable with OpenTelemetry support
  • ✅ Secure with OAuth2 authentication

For detailed documentation, see [README.md](README.md).
Assets 3
Loading

Latest build

24 Nov 15:57
@github-actions github-actions
latest
cb08f8d

Choose a tag to compare

View all tags
Latest build Pre-release
Pre-release

Changelog

All notable changes to the DevStack API Service project will be documented in this file.

The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.

[0.0.1-SNAPSHOT] - 2025-11-27

Added

Core Features

  • Spring Boot 3.5.7 based REST API service for managing DevStack project lifecycles
  • Java 21 support with Maven multi-module architecture
  • OpenAPI/Swagger documentation and code generation
  • OAuth2 Resource Server authentication and authorization
  • Spring Boot Actuator for monitoring and management endpoints
  • OpenTelemetry instrumentation for distributed tracing and observability

API Modules

Project Platform API (api-project-platform)
  • REST endpoints for managing project platform information
  • Get platform information for projects (GET /api/v1/projects/{projectKey}/platforms)
  • Returns disabled platforms and categorized platform links
  • OpenAPI specification: api-project-platform.yaml
Project Users API (api-project-users)
  • REST endpoints for managing project users and roles
  • Trigger membership requests (POST /api/v1/project/{projectKey}/users)
  • Retrieve user information by username (GET /api/v1/projects/{projectKey}/users/{username})
  • Get all users in a project (GET /api/v1/project/{projectKey}/users)
  • Revoke user access from projects (DELETE /api/v1/project/{projectKey}/users/{username})
  • OpenAPI specification: api-project-users.yaml

External Service Integrations

Ansible Automation Platform (AAP) (external-service-aap)
  • Integration with Ansible Automation Platform
  • Workflow automation capabilities
OpenShift Container Platform (OCP) (external-service-ocp)
  • OpenShift/Kubernetes cluster integration
  • Project and resource management on OpenShift
  • Comprehensive documentation in /doc/external-service-ocp/
Bitbucket (external-service-bitbucket)
  • Bitbucket API v89 integration
  • Source code repository management
  • OpenAPI client generated from openapi-bitbucket-v89.yaml
UIPath (external-service-uipath)
  • UIPath RPA platform integration
  • Process automation capabilities
Webhook Proxy (external-service-webhookproxy)
  • Webhook proxy service integration
  • Event-driven architecture support
  • Documentation in /doc/external-service-webhookproxy/
Projects Info Service (external-service-projects-info-service)
  • Project information retrieval service
  • Centralized project metadata management

Build & Deployment

Multi-Build Support
  • Standard JAR Build: Traditional Spring Boot executable JAR
  • GraalVM Native Binary: Fast startup, low memory footprint native compilation
  • Docker Images: Both standard and native Docker image builds
  • Makefile: Comprehensive build automation with targets:
    • make jar - Build Spring Boot JAR
    • make native - Build GraalVM native binary
    • make docker-native - Build native Docker image
    • make quick-start - Build and run immediately
    • make all - Build everything
CI/CD Pipeline
  • GitHub Actions workflow: release-latest.yml
    • Automated builds on push to master branch
    • Sequential job execution with workspace sharing via artifacts
    • Automatic Docker image build and push
    • Latest release creation with artifacts
    • Supports both PR and manual workflow dispatch

Development Tools

  • Maven Wrapper included (mvnw / mvnw.cmd)
  • JaCoCo code coverage reporting
  • SpotBugs static analysis integration
  • Spring Java Format code formatting
  • Surefire test reporting

Documentation

  • Comprehensive README.md with:
    • Prerequisites and setup instructions
    • Build options and usage examples
    • Development workflow guides
    • Docker support documentation
    • Troubleshooting section
  • Module-specific documentation in /doc/ directory
  • OpenAPI specifications for all API modules

Configuration

  • Externalized configuration via application.yaml
  • Spring profiles support
  • Environment-based configuration management

Security

  • OAuth2 Resource Server configuration
  • CORS support
  • Spring Security integration
  • SSL/TLS configuration support

Technical Stack

Frameworks & Libraries

  • Spring Boot: 3.5.7
  • Spring Security: OAuth2 Resource Server
  • SpringDoc OpenAPI: 2.8.13
  • OpenTelemetry: 2.20.1
  • Lombok: 1.18.42
  • Jackson Databind Nullable: 0.2.7

Build Tools

  • Maven: 3.x
  • GraalVM Native Build Tools: 0.11.1
  • OpenAPI Generator Maven Plugin: 7.15.0
  • Git Commit ID Plugin: 4.9.10

Testing & Quality

  • JUnit 5: Spring Boot Test
  • JaCoCo: 0.8.13
  • SpotBugs: 4.9.6
  • Maven Surefire: 3.5.4

Infrastructure

  • Java Runtime: Java 21
  • Container Support: Docker with native image option
  • Target Platforms: Linux, macOS, Windows (via Maven wrapper)

Release Notes

This is the initial release of the DevStack API Service - a stateless, microservices-based platform for managing DevStack project lifecycles. The service provides RESTful APIs for third-party applications and CLI tools, with minimal server-side data storage and integration with external identity providers.

Key Highlights

  • ✅ Production-ready Spring Boot 3.5.7 application
  • ✅ Complete API documentation with OpenAPI/Swagger
  • ✅ Multiple deployment options (JAR, Native Binary, Docker)
  • ✅ Comprehensive external service integrations
  • ✅ CI/CD pipeline with automated releases
  • ✅ Observable with OpenTelemetry support
  • ✅ Secure with OAuth2 authentication

For detailed documentation, see [README.md](README.md).
Loading