feat: add version endpoint

[paullatzelsperger]

What this PR changes/adds

This PR adds several things:

• an ApiVersionService that API modules
• a new API called the "Version API", that exposes that version information in an endpoint under /.well-known/api/v1/version
• GH checks to verify the version information was changed if an API changed.

An example of such a check is here:
https://github.com/paullatzelsperger/DataSpaceConnector/actions/runs/9141255716/job/25135444163

Why it does that

client information

Further notes

The check Verify-Api-Version is quite crude now, for example it does not assert that the version was actually incremented or, that the date string is plausible. Let's see how far we get and improve from there.

Linked Issue(s)

Closes #4181

Please be sure to take a look at the contributing guidelines and our etiquette for pull requests.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 44.73684% with 42 lines in your changes are missing coverage. Please review.

Project coverage is 75.23%. Comparing base (7f20ba5) to head (97ad718).
Report is 268 commits behind head on main.

Files	Patch %	Lines
...or/api/management/version/VersionApiExtension.java	0.00%	23 Missing ⚠️
...c/api/observability/ObservabilityApiExtension.java	60.00%	3 Missing and 1 partial ⚠️
...onfiguration/ControlApiConfigurationExtension.java	60.00%	3 Missing and 1 partial ⚠️
...iguration/ManagementApiConfigurationExtension.java	60.00%	3 Missing and 1 partial ⚠️
...dentitytrust/sts/StsApiConfigurationExtension.java	60.00%	3 Missing and 1 partial ⚠️
...va/org/eclipse/edc/boot/BootServicesExtension.java	0.00%	1 Missing ⚠️
...onnector/api/management/version/v1/VersionApi.java	0.00%	1 Missing ⚠️
...lipse/edc/spi/system/apiversion/VersionRecord.java	0.00%	1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4196      +/-   ##
==========================================
+ Coverage   71.74%   75.23%   +3.49%     
==========================================
  Files         919     1015      +96     
  Lines       18457    20622    +2165     
  Branches     1037     1161     +124     
==========================================
+ Hits        13242    15515    +2273     
+ Misses       4756     4593     -163     
- Partials      459      514      +55     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jimmarino]

Let's discuss this. I want to align what we do here with the approach to versioning endpoints in DSP, which is not to say this is un-aligned. I'd like to make sure we have a wholistic approach and a DR for it.

[paullatzelsperger]

I'd like to make sure we have a wholistic approach and a DR for it.

https://github.com/eclipse-edc/Connector/tree/main/docs/developer/decision-records/2023-11-09-api-versioning

However, the D-R does not go into details on how the version information is to be stored (obviously it has to be a file).

To me, the more valuable feature is the CI check anyways, and it took way more time to get quite right (GitHub is a bit picky with git checkouts). I'm less worried about what the URL path or the response schema is but this is the reason it is still in draft :)

[jimmarino]

I'd like to make sure we have a wholistic approach and a DR for it.

https://github.com/eclipse-edc/Connector/tree/main/docs/developer/decision-records/2023-11-09-api-versioning

However, the D-R does not go into details on how the version information is to be stored (obviously it has to be a file).

To me, the more valuable feature is the CI check anyways, and it took way more time to get quite right (GitHub is a bit picky with git checkouts). I'm less worried about what the URL path or the response schema is but this is the reason it is still in draft :)

I'm referring to version discoverability similar to what DSP has. We can discuss.