Skip to content

Conversation

@Deekshit014
Copy link

Proposed changes

Please include a summary of the changes here and why we need those changes. And also let us know which issue is fixed.

This PR resolves Issue #1528, where the embedded Swagger UI failed to correctly prompt for and substitute the identity ID (iid) in the path for GET /identities/{iid} and PATCH /identities/{iid} API calls.

The issue was caused by missing Go Swagger annotations (@Param) above the relevant route handler declarations.

The fix involves adding the necessary annotations to ensure the Swagger documentation generator correctly maps the path variable to a user input field, allowing the API calls to execute properly from the UI.

Fixes #1528


Types of changes

  • Bug fix
  • New feature added
  • Documentation Update

Please make sure to follow these points

  • I have read the contributing guidelines.
  • I have performed a self-review of my own code or work.
  • I have commented my code, particularly in hard-to-understand areas.
  • My changes generates no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • My changes have sufficient code coverage (unit, integration, e2e tests).

Screenshots (If Applicable)


Other Information

The Swagger annotations were added to the route_get_identity_by_id.go and route_patch_update_identity.go files, and the documentation was regenerated using the swag tool.

I have verified the fix locally by running the FireFly stack and testing both the GET and PATCH identity endpoints in the Swagger UI.

@Deekshit014 Deekshit014 requested a review from a team as a code owner October 10, 2025 02:11
@Deekshit014 Deekshit014 force-pushed the fix/swagger-identity-1528 branch from f4e5ac9 to 7342300 Compare October 10, 2025 02:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Swagger issue when working with identities

1 participant