Documentation improvements. (#604)

TBD54566975 · Jul 27, 2023 · b3ad6d1 · b3ad6d1
1 parent f836a81
commit b3ad6d1
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 11 deletions.
diff --git a/doc/swagger.yaml b/doc/swagger.yaml
@@ -1935,9 +1935,9 @@ definitions:
     properties:
       applicationJwt:
         description: |-
-          Contains the following properties:
-          Application  manifestsdk.CredentialApplication `json:"credential_application" validate:"required"`
-          Credentials  []interface{}                     `json:"vcs" validate:"required"`
+          A JWT signed by the applicant. The payload MUST contain the following properties:
+          - `credential_application`: an object of type manifest.CredentialApplication (specified in https://identity.foundation/credential-manifest/#credential-application).
+          - `vcs`: an array of Verifiable Credentials.
         type: string
     required:
     - applicationJwt
@@ -3121,8 +3121,9 @@ paths:
     put:
       consumes:
       - application/json
-      description: Submit a credential application in response to a credential manifest.
-        The request body is expected to
+      description: |-
+        Submit a credential application in response to a credential manifest. The request body is expected to
+        be a valid JWT signed by the applicant's DID, containing two top level properties: `credential_application` and `vcs`.
       parameters:
       - description: request body
         in: body

diff --git a/pkg/server/router/manifest.go b/pkg/server/router/manifest.go
@@ -243,9 +243,9 @@ func (mr ManifestRouter) DeleteManifest(c *gin.Context) {
 }
 
 type SubmitApplicationRequest struct {
-	// Contains the following properties:
-	// Application  manifestsdk.CredentialApplication `json:"credential_application" validate:"required"`
-	// Credentials  []interface{}                     `json:"vcs" validate:"required"`
+	// A JWT signed by the applicant. The payload MUST contain the following properties:
+	// - `credential_application`: an object of type manifest.CredentialApplication (specified in https://identity.foundation/credential-manifest/#credential-application).
+	// - `vcs`: an array of Verifiable Credentials.
 	ApplicationJWT keyaccess.JWT `json:"applicationJwt" validate:"required"`
 }
 
@@ -317,9 +317,7 @@ type SubmitApplicationResponse struct {
 //
 //	@Summary		Submit application
 //	@Description	Submit a credential application in response to a credential manifest. The request body is expected to
-//
-// be a valid JWT signed by the applicant's DID, containing two top level properties: credential_application and vcs.
-//
+//	@Description	be a valid JWT signed by the applicant's DID, containing two top level properties: `credential_application` and `vcs`.
 //	@Tags			ApplicationAPI
 //	@Accept			json
 //	@Produce		json