Merge pull request mosip#861 from MeghaMaledar/develop

MOSIP-35179 Add description for eSignet
Infosys · Sep 2, 2024 · 7d9e3b8 · 7d9e3b8
2 parents 12d04b0 + b5ceb50
commit 7d9e3b8
Show file tree

Hide file tree

Showing 28 changed files with 381 additions and 0 deletions.
diff --git a/apitest/src/main/resources/esignet/CreateOIDCClient/CreateOIDCClient.yml b/apitest/src/main/resources/esignet/CreateOIDCClient/CreateOIDCClient.yml
@@ -1,6 +1,7 @@
 CreateOIDCClient:
    ESignet_CreateOIDCClient_all_Valid_Smoke_sid:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with all valid data
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -29,6 +30,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_2_Same_RelyParty_Valid_Smoke_sid:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with two same relying party
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -57,6 +59,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Invalid_RequestTime_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with invalid requestTime and all valid data
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -89,6 +92,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Diff_RequestTime_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with different requestTime
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -121,6 +125,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_StatusCode_Invalid_Token_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with invalid token
       role: resident
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -146,6 +151,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_StatusCode_Diff_Token_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with different invalid token
       role: idrepo
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -171,6 +177,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Invalid_Range_ClientId_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with invalid range clientId
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -203,6 +210,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Exceding_Range_ClientId_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with exceding range clientId
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -235,6 +243,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Invalid_Range_ClientName_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with invalid range clientName
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -267,6 +276,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Exceding_Range_ClientName_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with exceding range clientName
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -299,6 +309,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Invalid_SpaceFirst_ClientId_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with a value starting with space in clientId
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -331,6 +342,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Invalid_SpaceLast_ClientId_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with a value ending with space in clientId
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -363,6 +375,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Invalid_SpaceMiddle_ClientId_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with clientId value having space in middle 
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -395,6 +408,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Invalid_Range_relyingPartyId_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with invalid range relyingpartyId
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -427,6 +441,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Invalid_Exceding_Range_relyingPartyId_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with exceding range relyingpartyId
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -459,6 +474,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Invalid_Range_logoUri_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with invalid range logoUri
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -491,6 +507,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Invalid_Exceding_Range_logoUri_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with exceding range logoUri
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -523,6 +540,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Missing_redirectUris:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with with missing redirectUris
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -555,6 +573,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Invalid_authContextRefs:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with invaid authContextRefs
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -587,6 +606,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Null_authContextRefs:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with null value in authContextRefs
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -619,6 +639,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Missing_authContextRefs:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with missing authContextRefs
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -651,6 +672,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Empty_authContextRefs:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with missing authContextRefs
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -683,6 +705,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Invalid_publicKey:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with invalid publicKey
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClientInvPublicKey
@@ -714,6 +737,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Invalid_UserClaims:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with invalid userClaims
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -746,6 +770,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Missing_grantTypes_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with missing grantTypes
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -778,6 +803,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Null_grantTypes_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with null value in grantTypes
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -810,6 +836,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Invalid_grantTypes_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with different invalid grantTypes
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -842,6 +869,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Empty_grantTypes_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with an empty grantTypes
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -874,6 +902,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Missing_clientAuthMethods_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with missing clientAuthMethods
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -906,6 +935,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Invalid_clientAuthMethods_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with different invalid clientAuthMethods
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -938,6 +968,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Empty_clientAuthMethods_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with an empty clientAuthMethods
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient
@@ -970,6 +1001,7 @@ CreateOIDCClient:
 
    ESignet_CreateOIDCClient_Null_clientAuthMethods_Neg:
       endPoint: /v1/esignet/client-mgmt/oidc-client
+      description: To create OIDC Client with null value in clientAuthMethods
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClient/CreateOIDCClient

diff --git a/apitest/src/main/resources/esignet/CreateOIDCClientV2/CreateOIDCClient.yml b/apitest/src/main/resources/esignet/CreateOIDCClientV2/CreateOIDCClient.yml
@@ -1,6 +1,7 @@
 CreateOIDCClientV2:
    ESignet_CreateOIDCClientV2_all_Valid_Smoke_sid:
       endPoint: /v1/esignet/client-mgmt/oauth-client
+      description: To create OIDC Client V2 with all valid data
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClientV2/CreateOIDCClient
@@ -31,6 +32,7 @@ CreateOIDCClientV2:
 
    ESignet_CreateOIDCClientV2_Invalid_langCode_Size_Neg:
       endPoint: /v1/esignet/client-mgmt/oauth-client
+      description: To create OIDC Client V2 with invalid language code size
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClientV2/CreateOIDCClient
@@ -64,6 +66,7 @@ CreateOIDCClientV2:
 
    ESignet_CreateOIDCClientV2_Invalid_langCode_Neg:
       endPoint: /v1/esignet/client-mgmt/oauth-client
+      description: To create OIDC Client V2 with invalid language code
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClientV2/CreateOIDCClient
@@ -97,6 +100,7 @@ CreateOIDCClientV2:
 
    ESignet_CreateOIDCClientV2_Invalid_clientNameLang_Neg:
       endPoint: /v1/esignet/client-mgmt/oauth-client
+      description: To create OIDC Client V2 with invalid clientNameLang
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClientV2/CreateOIDCClient
@@ -130,6 +134,7 @@ CreateOIDCClientV2:
 
    ESignet_CreateOIDCClientV2_Missing_ClientNamelangMap_Value_Neg:
       endPoint: /v1/esignet/client-mgmt/oauth-client
+      description: To create OIDC Client V2 with missing clientNameLangMap value
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClientV2/CreateOIDCClientWOClientLangMapValue
@@ -161,6 +166,7 @@ CreateOIDCClientV2:
 
    ESignet_CreateOIDCClientV2_Missing_ClientNamelangMap_Neg:
       endPoint: /v1/esignet/client-mgmt/oauth-client
+      description: To create OIDC Client V2 with missing ClientNamelangMap
       role: partner
       restMethod: post
       inputTemplate: esignet/CreateOIDCClientV2/CreateOIDCClientWOClientLangMap

diff --git a/apitest/src/main/resources/esignet/OAuthDetailsRequestV2/OAuthDetailsRequest.yml b/apitest/src/main/resources/esignet/OAuthDetailsRequestV2/OAuthDetailsRequest.yml
@@ -1,6 +1,7 @@
 OAuthDetailsRequestV2:
    ESignet_OAuthDetailsRequest_V2_uin_all_Valid_Smoke_sid:
       endPoint: /v1/esignet/authorization/v2/oauth-details
+      description: To get OAuthDetails V2  with all valid data
       role: resident
       restMethod: post
       checkErrorsOnlyInResponse: true
@@ -27,6 +28,7 @@ OAuthDetailsRequestV2:
 
    ESignet_OAuthDetailsRequest_V2_uin_1stLang_all_Valid_Smoke_sid:
       endPoint: /v1/esignet/authorization/v2/oauth-details
+      description: To get OAuthDetails V2  with first language and all valid data
       role: resident
       restMethod: post
       checkErrorsOnlyInResponse: true

diff --git a/...src/main/resources/esignet/SunBirdC/AuthenticateUserSunBirdC/AuthenticateUserSunBirdC.yml b/...src/main/resources/esignet/SunBirdC/AuthenticateUserSunBirdC/AuthenticateUserSunBirdC.yml
@@ -1,6 +1,7 @@
 AuthenticateUserSunBirdC:
    ESignet_AuthenticateUserSunBirdC_Valid_Smoke:
       endPoint: $ESIGNETMOCKBASEURL$/v1/esignet/authorization/authenticate
+      description: To Authenticate the User for SunBirdC with all valid data
       role: resident
       restMethod: post
       checkErrorsOnlyInResponse: true

diff --git a/...c/main/resources/esignet/SunBirdC/AuthorizationCodeSunBirdC/AuthorizationCodeSunBirdC.yml b/...c/main/resources/esignet/SunBirdC/AuthorizationCodeSunBirdC/AuthorizationCodeSunBirdC.yml
@@ -1,6 +1,7 @@
 AuthorizationCodeSunBirdC:
    ESignet_AuthorizationCode_SunBirdC_All_Valid_Smoke_sid:
       endPoint: $ESIGNETMOCKBASEURL$/v1/esignet/authorization/auth-code
+      description: To Authorize the user for SunBirdC with all valid data
       role: resident
       restMethod: post
       checkErrorsOnlyInResponse: true

diff --git a/...main/resources/esignet/SunBirdC/CreateOIDCClientV2SunBirdC/CreateOIDCClientV2SunBirdC.yml b/...main/resources/esignet/SunBirdC/CreateOIDCClientV2SunBirdC/CreateOIDCClientV2SunBirdC.yml
@@ -1,6 +1,7 @@
 CreateOIDCClientV2SunBirdC:
    ESignet_CreateOIDCClientV2SunBirdC_all_Valid_Smoke_sid:
       endPoint: $ESIGNETMOCKBASEURL$/v1/esignet/client-mgmt/oauth-client
+      description: To create OIDCClientV2 for SunbirdC with all valid data
       role: partner
       restMethod: post
       inputTemplate: esignet/SunBirdC/CreateOIDCClientV2SunBirdC/CreateOIDCClientV2SunBirdC

diff --git a/apitest/src/main/resources/esignet/SunBirdC/GenerateTokenSunBirdC/GenerateTokenSunBirdC.yml b/apitest/src/main/resources/esignet/SunBirdC/GenerateTokenSunBirdC/GenerateTokenSunBirdC.yml
@@ -1,6 +1,7 @@
 GenerateTokenSunBirdC:
    ESignet_GenerateTokenSunBirdC_Valid_Smoke_sid:
       endPoint: $ESIGNETMOCKBASEURL$/v1/esignet/oauth/v2/token
+      description: To Generate token for SunBirdC with all valid data
       role: resident
       restMethod: post
       validityCheckRequired: true

diff --git a/apitest/src/main/resources/esignet/SunBirdC/GetCredentialSunBirdC/GetCredentialSunBirdC.yml b/apitest/src/main/resources/esignet/SunBirdC/GetCredentialSunBirdC/GetCredentialSunBirdC.yml
@@ -1,6 +1,7 @@
 GetCredentialSunBirdC:
    ESignet_GetCredentialSunBirdC_IdpAccessToken_all_Valid_Smoke:
       endPoint: $ESIGNETMOCKBASEURL$/v1/esignet/vci/credential
+      description: To get Credential for SunBirdC by providing IdpAccessToken and all valid data
       role: resident
       checkErrorsOnlyInResponse: true
       restMethod: post

diff --git a/...in/resources/esignet/SunBirdC/OAuthDetailsRequestSunBirdC/OAuthDetailsRequestSunBirdC.yml b/...in/resources/esignet/SunBirdC/OAuthDetailsRequestSunBirdC/OAuthDetailsRequestSunBirdC.yml
@@ -1,6 +1,7 @@
 OAuthDetailsRequestSunBirdC:
    ESignet_OAuthDetailsRequest_SunBirdC_all_Valid_Smoke_sid:
       endPoint: $ESIGNETMOCKBASEURL$/v1/esignet/authorization/v2/oauth-details
+      description: To Request OAuthDetails for SunBirdC with all valid data
       role: resident
       restMethod: post
       checkErrorsOnlyInResponse: true