v5.0.0

Breaking Changes

• Pharo 6.1 is no longer supported
• Permissions on JWT tokens are now encoded in a permissions claim and not shadowing scope, to match Auth0 access tokens.
• Updated dependencies: Buoy v6 , Launchpad v3 and Hyperspace v2

Non Breaking Changes

• Added shellcheck to the build and fix related warnings on the shell scripts
• Use GitHub actions and CodeCov
• Updated dependencies: JRPC v3.1 and JSONWebToken v0.3

Migration Guide

• Issued JWT tokens used for operations needs to be re-issued following the new guidelines.
• Account for the new dependency versions

v4.1.3

Changelog

• PR #99 Fixed a bug during content negotiation when multiple Accept lines are present in the incoming request

v4.1.2

Changelog

• PR #96 Fixed some method categories
• PR #97 Moved the abstract class for testing operational plugins to another package

v4.1.1

Changelog

• PR #94 Improve caching directive code using the new facilities in Hyperspace

v4.1.0

Changelog

• PR #86 and #87 : Add support for caching directives and Expires
• PR #88 Improved documentation on API startup
• PR #91 Update ApplicationStarter to Launchpad dependency

v4.0.3

Changelog

• PR #82 Add sample bash scripts to consume the operational plugin APIs
• PR #83 Update JSONWebToken dependency to v0.2.5 on the official repo

v4.0.2

Changelog

• #79 Fix application-configuration plugin to handle correctly the sensitive arguments. In JSON output it will not fail anymore and for the textual representation it will not expose the value.

v4.0.1

Changelog

• Updated ApplicationStarter dependency to v2

v4.0.0

Changelog

• #41 Implemented support for operational plugins: Operational plugins bring production-ready features to your application supporting the operations team. See the documentation
• #40 Health Check Plugin. See the documentation
• #42 Application Configuration Plugin: See the documentation
• #43 Application Info Plugin: See the documentation
• #45 Application Control: See the documentation
• #46 Metrics Plugin: See the documentation
• Authentication Filters allows to protect selected routes under an authentication scheme. To protect an specific route just decorate it sending authenticatedBy: with a proper authentication filter. Currently two options are supported:
  • JWTBearer Auth: In this case the permissions contained in the claims are available in the HttpRequestContext after a successful authentication.
  • Basic Auth: Integrating the facilities already provided by Zinc HTTP Components
• JSON RPC Integration: Now you can combine JSON RPC endpoints in your REST API, just use JsonRPCRequestHandler in the controller and provide the corresponding route definition. This integration is made against juliendelplanque/JRPC library
• SUnit extensions: Now you can subclass HTTPBasedRESTfulAPITest in case you want to test an API

Migration Guide

• Now you need to provide an #operations key in the API configuration as explained in the documentation

v3.2.0

Non breaking changes

• PR #66 Added a facility to the request builder to hash the encoded representation of a resource to calculate the ETag value. Thanks @fortizpenaloza