Version the APIs that are published to SwaggerHub

[paullatzelsperger]

Feature Request

Currently we publish every iteration of our API spec as 0.0.1-SNAPSHOT, which should be improved. Every release of EDC should also produce a versioned API spec in SwaggerHub.

We should not do this on nightlies, because that would absolutely SPAM SwaggerHub.

Which Areas Would Be Affected?

build, CI

Why Is the Feature Desired?

Downstream projects use pinned versions of EDC, and they currently have no way of referencing their version of the EDC APIs.

Solution Proposal

• improve the generation of the API to make the version input configurable:

// root build.gradle.kts
swagger {
       title.set((project.findProperty("apiTitle") ?: "EDC REST API") as String)
       description =
           (project.findProperty("apiDescription") ?: "EDC REST APIs - merged by OpenApiMerger") as String
       version = project.version // <-- this is new, ties it to the project version, override with -Pversion=...
       outputFilename.set(project.name)
       outputDirectory.set(file("${rootProject.projectDir.path}/resources/openapi/yaml"))
   }

• make the apidoc.yaml workflow user-triggerable (workflow_dispatch)
• avoid publishing API specs on nightlies
• for manual triggering: add an optional version input to it and use that version input to set the API version

[ndr-brt]

duplicated of #2699 ? Maybe more detailed so we could close the other

[github-actions]

This issue is stale because it has been open for 28 days with no activity.