PTS Registry API - Release Notes

All notable changes to the PTS Registry API will be documented in this file.

Subscribe to notifications on #ext-utv-pts on Slack to be notified when we announce new releases.

You'll also notice we often use icons to visualize our changes and their effect, but we've limited ourselves to the following;

• 🌱 New Feature
• 🍃 Improvement
• 🔧 Bug Fix
• 💥 Breaking Change
• 🔒 Security

Only changes that reach a public surface are listed.

1.0.5

• 💥 A restriction carries at most one period. conditions.periods is now conditions.period.
• 💥 Removed the rule that periods must not overlap, and the limit of twenty periods per restriction, together with the restriction.conditions.periods_overlap error.
• 💥 Renamed restriction.conditions.periods_not_allowed to restriction.conditions.period_not_allowed.

1.0.4

• 💥 The two models inside a resolution are now named RestrictionResolutionPersonActorDto and RestrictionResolutionCapacityActorDto, so the generated OpenAPI schema names match the code rather than reading RestrictionActorDtoRestrictionPersonActorDto.

1.0.3

• 💥 resolve requires a domain and a resource type alongside a resource identifier.
• 💥 Removed breadth from the API. How much a restriction covers is derived from the domain and resource it names, and the error for writing one too wide is restriction.provision.not_allowed_this_wide, carrying covers in its metadata.
• 💥 Removed the last of the target vocabulary, flattening the snapshot compact returns.

1.0.2

• 💥 Replaced appliesTo with a reach, and allowed a provision to reach the descendants of a resource rather than only the resource itself.
• 💥 Flattened the domain and the resource out of the wrapped target and onto the restriction itself, and collapsed the polymorphic provision class.
• 💥 A resource is optional, so a restriction may cover a whole domain or a whole resource type.
• 💥 Breadth is permitted per code system, so 9603 and 9604 differ in how wide they may be written.
• 💥 Replaced DiagnosticReport with ServiceRequest throughout.
• 💥 Removed the parts of the API surface that existed only to fit 9603.

1.0.1

• 💥 Every restriction target carries a domain and a resource type.
• 💥 Replaced directives with provisions.
• 💥 revoke takes a provision selector, so it names which provision is being lifted.
• 💥 Conditions may carry a duration, for a provision whose window is counted from a resource that does not exist yet.
• 💥 The subject's date of birth travels with a restriction, taken from Pts.Person.Api, replacing the age windows this registry used to compute. The age threshold belongs to Helsedirektoratet, not here.
• 💥 Added appliesTo to say how far a restriction reaches.
• 💥 Removed the supersession ordinal from every public surface.

1.0.0

The first version the service reported.

It was reached without any released predecessor, so this section describes the surface rather than a set of changes.

• 💥 /api/v1/restrictions with create, query, compact, resolve and revoke, plus a cursor-paged list and a get-by-id.
• 💥 Restrictions are the aggregate root, with the subject embedded, and provision values are strongly typed and polymorphic.
• 💥 compact returns what is in force per resource and code system; resolve answers for one actor.
• 💥 HelseID with DPoP, and CORS for the developer portal.