fix: Openapi spec version and update gh workflow (#470)

* fix: Openapi spec version and update gh workflow

* fix: Inject version via modifiers

Author: tirumerla

.github/workflows/release-please.yml

@@ -182,6 +182,61 @@ jobs:
             Cargo.lock
             docs/antora.yml
 
+  # Update openapi json file
+  update-openapi-spec-file:
+    name: Update openapi.json file
+    needs: release-please
+    if: ${{ needs.release-please.outputs.release_created == 'false' &&  needs.release-please.outputs.pr_created == 'true' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden the runner (Audit all outbound calls)
+        uses: step-security/harden-runner@ec9f2d5744a09debf3a187a3f4f675c53b671911  # v2.13.0
+        with:
+          egress-policy: audit
+      - name: Get github app token
+        uses: actions/create-github-app-token@a8d616148505b5069dccd32f177bb87d7f39123b  # v2.1.1
+        id: gh-app-token
+        with:
+          app-id: ${{ vars.GH_APP_ID }}
+          private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
+      - name: Get PR details
+        id: release-branch
+        run: |
+          echo "pr head branch name: >>>>> ${{ needs.release-please.outputs.release_branch }}"
+      - name: Checkout release branch
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+        with:
+          fetch-depth: 2
+          token: ${{ steps.gh-app-token.outputs.token }}
+          ref: ${{ needs.release-please.outputs.release_branch }}
+      - name: Get GitHub App User ID
+        id: get-user-id
+        run: echo "user-id=$(gh api "/users/${{ steps.gh-app-token.outputs.app-slug }}[bot]" --jq .id)" >> "$GITHUB_OUTPUT"
+        env:
+          GH_TOKEN: ${{ steps.gh-app-token.outputs.token }}
+      - name: Prepare
+        id: init
+        uses: ./.github/actions/prepare
+      - name: Cargo generate api
+        id: update-openapi-spec-commit
+        run: |-
+          OPENAPI_SPEC_FILE="docs/openapi.json"
+          cargo generate_openapi
+          if ! git diff --quiet "$OPENAPI_SPEC_FILE"; then
+            echo "openapi_changed=true" >> $GITHUB_OUTPUT
+          else
+            echo "openapi_changed=false" >> $GITHUB_OUTPUT
+          fi
+      - name: Commit openapi spec file
+        if: steps.update-openapi-spec-commit.outputs.openapi_changed == 'true'
+        uses: iarekylew00t/verified-bot-commit@cc09d455be3e20eb6b1c3d1c30a5221f9475aa10  # v1.5.1
+        with:
+          message: 'chore: Updating openapi spec file and bumping version'
+          token: ${{ steps.gh-app-token.outputs.token }}
+          ref: ${{ needs.release-please.outputs.release_branch }}
+          files: |-
+            docs/openapi.json
+
   # Update rust docs link in nav.adoc
   update-rust-docs-link:
     needs: release-please

docs/openapi.json

@@ -12,7 +12,7 @@
       "name": "AGPL-3.0 license",
       "url": "https://github.com/OpenZeppelin/openzeppelin-relayer/blob/main/LICENSE"
     },
-    "version": "1.0.0"
+    "version": "1.1.0"
   },
   "paths": {
     "/api/v1/notifications": {

src/openapi.rs

@@ -11,6 +11,15 @@ use utoipa::{
     Modify, OpenApi,
 };
 
+const API_VERSION: &str = env!("CARGO_PKG_VERSION");
+
+struct VersionFromEnv;
+
+impl Modify for VersionFromEnv {
+    fn modify(&self, openapi: &mut utoipa::openapi::OpenApi) {
+        openapi.info.version = API_VERSION.to_string();
+    }
+}
 struct SecurityAddon;
 
 impl Modify for SecurityAddon {
@@ -29,7 +38,7 @@ impl Modify for SecurityAddon {
 /// OpenZeppelin Relayer API definitions.
 #[derive(OpenApi)]
 #[openapi(
-    modifiers(&SecurityAddon),
+    modifiers(&SecurityAddon, &VersionFromEnv),
     tags(
       (name = "Relayers", description = "Relayers are the core components of the OpenZeppelin Relayer API. They are responsible for executing transactions on behalf of users and providing a secure and reliable way to interact with the blockchain."),
       (name = "Plugins", description = "Plugins are TypeScript functions that can be used to extend the OpenZeppelin Relayer API functionality."),
@@ -38,7 +47,7 @@ impl Modify for SecurityAddon {
       (name = "Metrics", description = "Metrics are responsible for showing the metrics related to the relayers."),
       (name = "Health", description = "Health is responsible for showing the health of the relayers.")
     ),
-    info(description = "OpenZeppelin Relayer API", version = "1.0.0", title = "OpenZeppelin Relayer API",  license(
+    info(description = "OpenZeppelin Relayer API", version = "0.0.0", title = "OpenZeppelin Relayer API",  license(
         name = "AGPL-3.0 license",
         url = "https://github.com/OpenZeppelin/openzeppelin-relayer/blob/main/LICENSE"
     ),