From 73423002532d32a5efb5d4651cb641cdf98ee443 Mon Sep 17 00:00:00 2001 From: Deekshit S Date: Fri, 10 Oct 2025 07:38:23 +0530 Subject: [PATCH] Fix: Add missing Swagger annotations for identity path parameters (fixes #1528) Signed-off-by: Deekshit S --- .../apiserver/route_get_identity_by_id.go | 7 ++++ .../apiserver/route_patch_update_identity.go | 9 +++++ internal/swagger/docs.go | 36 +++++++++++++++++++ internal/swagger/swagger.json | 7 ++++ internal/swagger/swagger.yaml | 4 +++ 5 files changed, 63 insertions(+) create mode 100644 internal/swagger/docs.go create mode 100644 internal/swagger/swagger.json create mode 100644 internal/swagger/swagger.yaml diff --git a/internal/apiserver/route_get_identity_by_id.go b/internal/apiserver/route_get_identity_by_id.go index f489682993..14da11e82a 100644 --- a/internal/apiserver/route_get_identity_by_id.go +++ b/internal/apiserver/route_get_identity_by_id.go @@ -25,6 +25,13 @@ import ( "github.com/hyperledger/firefly/pkg/core" ) +// @Summary Get identity by ID +// @ID getIdentityByID +// @Tags identities +// @Produce json +// @Param iid path string true "Identity ID" +// @Success 200 {object} core.Identity +// @Router /identities/{iid} [get] var getIdentityByID = &ffapi.Route{ Name: "getIdentityByID", Path: "identities/{iid}", diff --git a/internal/apiserver/route_patch_update_identity.go b/internal/apiserver/route_patch_update_identity.go index 46ec71e84e..6767cdb7f2 100644 --- a/internal/apiserver/route_patch_update_identity.go +++ b/internal/apiserver/route_patch_update_identity.go @@ -25,6 +25,15 @@ import ( "github.com/hyperledger/firefly/pkg/core" ) +// @Summary Update an identity +// @ID patchUpdateIdentity +// @Tags identities +// @Accept json +// @Produce json +// @Param iid path string true "Identity ID" <-- THE CRITICAL FIX +// @Param body body core.IdentityUpdateDTO true "Identity update details" +// @Success 202 {object} core.Identity +// @Router /identities/{iid} [patch] var patchUpdateIdentity = &ffapi.Route{ Name: "patchUpdateIdentity", Path: "identities/{iid}", diff --git a/internal/swagger/docs.go b/internal/swagger/docs.go new file mode 100644 index 0000000000..3a76740b34 --- /dev/null +++ b/internal/swagger/docs.go @@ -0,0 +1,36 @@ +// Package swagger Code generated by swaggo/swag at 2025-10-10 07:17:54.1777731 +0530 IST m=+84.795132601. DO NOT EDIT +package swagger + +import "github.com/swaggo/swag" + +const docTemplate = `{ + "schemes": {{ marshal .Schemes }}, + "swagger": "2.0", + "info": { + "description": "{{escape .Description}}", + "title": "{{.Title}}", + "contact": {}, + "version": "{{.Version}}" + }, + "host": "{{.Host}}", + "basePath": "{{.BasePath}}", + "paths": {} +}` + +// SwaggerInfo holds exported Swagger Info so clients can modify it +var SwaggerInfo = &swag.Spec{ + Version: "", + Host: "", + BasePath: "", + Schemes: []string{}, + Title: "", + Description: "", + InfoInstanceName: "swagger", + SwaggerTemplate: docTemplate, + LeftDelim: "{{", + RightDelim: "}}", +} + +func init() { + swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) +} diff --git a/internal/swagger/swagger.json b/internal/swagger/swagger.json new file mode 100644 index 0000000000..ec416cd4a1 --- /dev/null +++ b/internal/swagger/swagger.json @@ -0,0 +1,7 @@ +{ + "swagger": "2.0", + "info": { + "contact": {} + }, + "paths": {} +} \ No newline at end of file diff --git a/internal/swagger/swagger.yaml b/internal/swagger/swagger.yaml new file mode 100644 index 0000000000..b64379cad9 --- /dev/null +++ b/internal/swagger/swagger.yaml @@ -0,0 +1,4 @@ +info: + contact: {} +paths: {} +swagger: "2.0"