mirrors/activitypub-federation-rust
1
0
Fork 0
mirror of https://github.com/LemmyNet/activitypub-federation-rust.git synced 2024-06-10 09:19:34 +00:00
Code Issues Projects Releases Wiki Activity

Update docs for build_webfinger_response

Browse source
This commit is contained in:
Grafcube 2023-03-31 21:22:46 +05:30
parent 3f70586e63
commit d549b307cc
No known key found for this signature in database
GPG key ID: E383688F2878A440
1 changed files with 23 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
src/fetch/webfinger.rs
View file

@ -81,18 +81,39 @@ where
.to_string())
}
/// Builds a basic webfinger response for the actor.
/// Builds a basic webfinger response for the actors with optional type.
///
/// It assumes that the given URL is valid both to the view the actor in a browser as HTML, and
/// for fetching it over Activitypub with `activity+json`. This setup is commonly used for ease
/// of discovery.
///
/// `url` takes a vector of tuples. The first item of the tuple is the URL while the second
/// item is the type, such as `"Person"` or `"Group"`. If `None` is passed for the type, the field
/// will be empty.
///
/// ```
/// # use url::Url;
/// # use activitypub_federation::fetch::webfinger::build_webfinger_response;
/// let subject = "acct:nutomic@lemmy.ml".to_string();
/// let url = Url::parse("https://lemmy.ml/u/nutomic")?;
/// build_webfinger_response(subject, url);
/// build_webfinger_response(subject, vec![(url, None)]);
/// # Ok::<(), anyhow::Error>(())
/// ```
///
/// ```
/// # use url::Url;
/// # use activitypub_federation::fetch::webfinger::build_webfinger_response;
/// let subject = "acct:nutomic@lemmy.ml".to_string();
/// let url = Url::parse("https://lemmy.ml/u/nutomic")?;
/// build_webfinger_response(subject, vec![(url, Some("Person"))]);
/// # Ok::<(), anyhow::Error>(())
/// ```
/// ```
/// # use url::Url;
/// # use activitypub_federation::fetch::webfinger::build_webfinger_response;
/// let subject = "acct:asklemmy@lemmy.ml".to_string();
/// let url = Url::parse("https://lemmy.ml/c/asklemmy")?;
/// build_webfinger_response(subject, vec![(url, Some("Group"))]);
/// # Ok::<(), anyhow::Error>(())
/// ```
pub fn build_webfinger_response(subject: String, url: Vec<(Url, Option<&str>)>) -> Webfinger {