Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: api spec documentation #1493

Merged
merged 1 commit into from
Jan 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -262,15 +262,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"
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -203,14 +203,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"
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")
)
Expand All @@ -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")
)
Expand Down
Loading