diff --git a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/issue/controller/http/IssueCredentialRecord.scala b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/issue/controller/http/IssueCredentialRecord.scala index 3e6b85f797..a496a1cf27 100644 --- a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/issue/controller/http/IssueCredentialRecord.scala +++ b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/issue/controller/http/IssueCredentialRecord.scala @@ -261,15 +261,19 @@ object IssueCredentialRecord { object goalcode extends Annotation[String]( - description = - "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message.", + description = """ + |A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message. + |The goalCode is optional and can be included when the credential offer originates from an invitation for connectionless issuance + |""".stripMargin, example = "issue-vc" ) object goal extends Annotation[String]( - description = - "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message.", + description = """ + |A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message. + |The goal is optional and can be included when the credential offer originates from an invitation for connectionless issuance + |""".stripMargin, example = "To issue a Faber College Graduate credential" ) diff --git a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/presentproof/controller/http/PresentationStatus.scala b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/presentproof/controller/http/PresentationStatus.scala index 72cc0807ef..8571a81f9f 100644 --- a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/presentproof/controller/http/PresentationStatus.scala +++ b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/presentproof/controller/http/PresentationStatus.scala @@ -201,14 +201,18 @@ object PresentationStatus { object goalcode extends Annotation[String]( description = - "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message.", + """A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message. + |The goalcode is optional and can be included when the presentation request originates from an invitation for connectionless proof request + |""".stripMargin, example = "present-vp" ) object goal extends Annotation[String]( description = - "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message.", + """A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message. + |The goal is optional and can be included when the presentation request originates from an invitation for connectionless proof request + |""".stripMargin, example = "To verify a Peter College Graduate credential" ) diff --git a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/presentproof/controller/http/RequestPresentationInput.scala b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/presentproof/controller/http/RequestPresentationInput.scala index 695094e2e1..5575fab297 100644 --- a/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/presentproof/controller/http/RequestPresentationInput.scala +++ b/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/presentproof/controller/http/RequestPresentationInput.scala @@ -59,7 +59,7 @@ object RequestPresentationInput { extends Annotation[Option[String]]( description = """ | A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message. - | goalcode is optional and can be provided when the presentation request is from invitation for connectionless verification. + | goalcode is optional and can be included when the presentation request is from invitation for connectionless verification. |""".stripMargin, example = Some("present-vp") ) @@ -68,7 +68,7 @@ object RequestPresentationInput { extends Annotation[Option[String]]( description = """ | A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message. - | goal is optional and can be provided when the presentation request is from invitation for connectionless verification. + | goal is optional and can be included when the presentation request is from invitation for connectionless verification. |""".stripMargin, example = Some("Request proof of vaccine") )