wip: renaming the api function

Signed-off-by: dwertent <[email protected]>
hyperledger · Aug 15, 2024 · 0ebc1d8 · 0ebc1d8
1 parent ab093be
commit 0ebc1d8
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/internal/apiserver/route_get_identity_by_id.go b/internal/apiserver/route_get_identity_by_id.go
@@ -27,17 +27,17 @@ import (
 	"github.com/hyperledger/firefly/pkg/core"
 )
 
-var getIdentityByID = &ffapi.Route{
-	Name:   "getIdentityByID",
-	Path:   "identities/{id:.+}",
+var getIdentityByIDOrDID = &ffapi.Route{
+	Name:   "getIdentityByIDOrDID",
+	Path:   "identities/{id:.+}", // Allow any character in the ID (including slashes), othrwise the DID will be split into multiple path segments
 	Method: http.MethodGet,
 	PathParams: []*ffapi.PathParam{
 		{Name: "id", Example: "id", Description: coremsgs.APIParamsIdentityIDs},
 	},
 	QueryParams: []*ffapi.QueryParam{
 		{Name: "fetchverifiers", Example: "true", Description: coremsgs.APIParamsFetchVerifiers, IsBool: true},
 	},
-	Description:     coremsgs.APIEndpointsGetIdentityByID,
+	Description:     coremsgs.APIEndpointsGetIdentityByIDOrDID,
 	JSONInputValue:  nil,
 	JSONOutputValue: func() interface{} { return &core.Identity{} },
 	JSONOutputCodes: []int{http.StatusOK},

diff --git a/internal/apiserver/routes.go b/internal/apiserver/routes.go
@@ -86,7 +86,7 @@ var routes = append(
 		getGroupByHash,
 		getGroups,
 		getIdentities,
-		getIdentityByID,
+		getIdentityByIDOrDID,
 		getIdentityDID,
 		getIdentityVerifiers,
 		getMsgByID,

diff --git a/internal/coremsgs/en_api_translations.go b/internal/coremsgs/en_api_translations.go
@@ -108,7 +108,7 @@ var (
 	APIEndpointsGetGroupByHash                  = ffm("api.endpoints.getGroupByHash", "Gets a group by its ID (hash)")
 	APIEndpointsGetGroups                       = ffm("api.endpoints.getGroups", "Gets a list of groups")
 	APIEndpointsGetIdentities                   = ffm("api.endpoints.getIdentities", "Gets a list of all identities that have been registered in the namespace")
-	APIEndpointsGetIdentityByID                 = ffm("api.endpoints.getIdentityByID", "Gets an identity by its ID (UUID/DID)")
+	APIEndpointsGetIdentityByIDOrDID            = ffm("api.endpoints.getIdentityByIDOrDID", "Gets an identity by its ID or DID")
 	APIEndpointsGetIdentityDID                  = ffm("api.endpoints.getIdentityDID", "Gets the DID for an identity based on its ID")
 	APIEndpointsGetIdentityVerifiers            = ffm("api.endpoints.getIdentityVerifiers", "Gets the verifiers for an identity")
 	APIEndpointsGetMsgByID                      = ffm("api.endpoints.getMsgByID", "Gets a message by its ID")