Add link to protocol spec as doc comments.

Signed-off-by: Naian <126972030+nain-F49FF806@users.noreply.github.com>
hyperledger · Nov 13, 2023 · a31e276 · a31e276
1 parent 8789e5d
commit a31e276
Show file tree

Hide file tree

Showing 7 changed files with 7 additions and 0 deletions.
diff --git a/messages/src/msg_fields/protocols/coordinate_mediation/keylist.rs b/messages/src/msg_fields/protocols/coordinate_mediation/keylist.rs
@@ -3,6 +3,7 @@ use typed_builder::TypedBuilder;
 
 use crate::{decorators::thread::Thread, msg_parts::MsgParts};
 
+/// https://github.com/hyperledger/aries-rfcs/blob/main/features/0211-route-coordination/README.md#key-list
 pub type Keylist = MsgParts<KeylistContent, KeylistDecorators>;
 
 #[derive(Clone, Debug, Deserialize, Serialize, Default, PartialEq, TypedBuilder)]

diff --git a/messages/src/msg_fields/protocols/coordinate_mediation/keylist_query.rs b/messages/src/msg_fields/protocols/coordinate_mediation/keylist_query.rs
@@ -3,6 +3,7 @@ use typed_builder::TypedBuilder;
 
 use crate::{decorators::thread::Thread, msg_parts::MsgParts};
 
+/// https://github.com/hyperledger/aries-rfcs/blob/main/features/0211-route-coordination/README.md#key-list-query
 pub type KeylistQuery = MsgParts<KeylistQueryContent>;
 
 #[derive(Clone, Debug, Deserialize, Serialize, Default, PartialEq, TypedBuilder)]

diff --git a/messages/src/msg_fields/protocols/coordinate_mediation/keylist_update.rs b/messages/src/msg_fields/protocols/coordinate_mediation/keylist_update.rs
@@ -3,6 +3,7 @@ use typed_builder::TypedBuilder;
 
 use crate::{decorators::thread::Thread, msg_parts::MsgParts};
 
+/// https://github.com/hyperledger/aries-rfcs/blob/main/features/0211-route-coordination/README.md#keylist-update
 pub type KeylistUpdate = MsgParts<KeylistUpdateContent>;
 
 #[derive(Clone, Debug, Deserialize, Serialize, Default, PartialEq, TypedBuilder)]

diff --git a/messages/src/msg_fields/protocols/coordinate_mediation/keylist_update_response.rs b/messages/src/msg_fields/protocols/coordinate_mediation/keylist_update_response.rs
@@ -4,6 +4,7 @@ use typed_builder::TypedBuilder;
 use super::keylist_update::KeylistUpdateItemAction;
 use crate::{decorators::thread::Thread, msg_parts::MsgParts};
 
+/// https://github.com/hyperledger/aries-rfcs/blob/main/features/0211-route-coordination/README.md#keylist-update-response
 pub type KeylistUpdateResponse =
  MsgParts<KeylistUpdateResponseContent, KeylistUpdateResponseDecorators>;
 

diff --git a/messages/src/msg_fields/protocols/coordinate_mediation/mediate_deny.rs b/messages/src/msg_fields/protocols/coordinate_mediation/mediate_deny.rs
@@ -3,6 +3,7 @@ use typed_builder::TypedBuilder;
 
 use crate::{decorators::thread::Thread, msg_parts::MsgParts};
 
+/// https://github.com/hyperledger/aries-rfcs/blob/main/features/0211-route-coordination/README.md#mediation-deny
 pub type MediateDeny = MsgParts<MediateDenyContent, MediateDenyDecorators>;
 
 #[derive(Clone, Debug, Deserialize, Serialize, Default, PartialEq, TypedBuilder)]

diff --git a/messages/src/msg_fields/protocols/coordinate_mediation/mediate_grant.rs b/messages/src/msg_fields/protocols/coordinate_mediation/mediate_grant.rs
@@ -3,6 +3,7 @@ use typed_builder::TypedBuilder;
 
 use crate::{decorators::thread::Thread, msg_parts::MsgParts};
 
+/// https://github.com/hyperledger/aries-rfcs/blob/main/features/0211-route-coordination/README.md#mediation-grant
 pub type MediateGrant = MsgParts<MediateGrantContent, MediateGrantDecorators>;
 
 #[derive(Clone, Debug, Deserialize, Serialize, Default, PartialEq, TypedBuilder)]

diff --git a/messages/src/msg_fields/protocols/coordinate_mediation/mediate_request.rs b/messages/src/msg_fields/protocols/coordinate_mediation/mediate_request.rs
@@ -3,6 +3,7 @@ use typed_builder::TypedBuilder;
 
 use crate::{decorators::thread::Thread, msg_parts::MsgParts};
 
+/// https://github.com/hyperledger/aries-rfcs/blob/main/features/0211-route-coordination/README.md#mediation-request
 pub type MediateRequest = MsgParts<MediateRequestContent>;
 
 #[derive(Clone, Debug, Deserialize, Serialize, Default, PartialEq, TypedBuilder)]