Skip to content

Commit 34a33e3

Browse files
committed
Update docs descriptions
1 parent fbfde39 commit 34a33e3

File tree

3 files changed

+38
-3
lines changed

3 files changed

+38
-3
lines changed

server/src/routes/address.rs

+13-1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ use crate::routes::{
2323
RouteError,
2424
};
2525

26+
/// /a/{address}
27+
///
28+
/// Here is an example of a valid request that looks up an address:
29+
/// ```url
30+
/// /a/0x225f137127d9067788314bc7fcc1f36746a3c3B5
31+
/// ```
2632
#[utoipa::path(
2733
get,
2834
tag = "Single Profile",
@@ -67,6 +73,12 @@ pub struct AddressGetBulkQuery {
6773
fresh: FreshQuery,
6874
}
6975

76+
/// /bulk/a
77+
///
78+
/// Here is an example of a valid request that looks up multiple addresses:
79+
/// ```url
80+
/// /bulk/a?addresses[]=0x225f137127d9067788314bc7fcc1f36746a3c3B5&addresses[]=0xd577D1322cB22eB6EAC1a008F62b18807921EFBc&addresses[]=0x8F8f07b6D61806Ec38febd15B07528dCF2903Ae7&addresses[]=0x8e8Db5CcEF88cca9d624701Db544989C996E3216&addresses[]=0xb8c2C29ee19D8307cb7255e1Cd9CbDE883A267d5&addresses[]=0xF1F78f308F08fDCAC933124ee8B52A376ff542B4
81+
/// ```
7082
#[utoipa::path(
7183
get,
7284
tag = "Bulk Profiles",
@@ -110,7 +122,7 @@ pub async fn get_bulk(
110122

111123
/// /sse/a
112124
///
113-
/// Here is an example of a valid request that looks up multiple addresses.
125+
/// Here is an example of a valid request that looks up multiple addresses:
114126
/// ```url
115127
/// /sse/a?addresses[]=0x225f137127d9067788314bc7fcc1f36746a3c3B5&addresses[]=0xd577D1322cB22eB6EAC1a008F62b18807921EFBc&addresses[]=0x8F8f07b6D61806Ec38febd15B07528dCF2903Ae7&addresses[]=0x8e8Db5CcEF88cca9d624701Db544989C996E3216&addresses[]=0xb8c2C29ee19D8307cb7255e1Cd9CbDE883A267d5&addresses[]=0xF1F78f308F08fDCAC933124ee8B52A376ff542B4
116128
/// ```

server/src/routes/name.rs

+13-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ use crate::models::bulk::{BulkResponse, ListResponse};
1818
use crate::models::sse::SSEResponse;
1919
use crate::routes::{profile_http_error_mapper, validate_bulk_input, FreshQuery, Qs, RouteError};
2020

21+
/// /bulk/n
22+
///
23+
/// Here is an example of a valid request that looks up a name:
24+
/// ```url
25+
/// /n/luc.eth
26+
/// ```
2127
#[utoipa::path(
2228
get,
2329
tag = "Single Profile",
@@ -60,6 +66,12 @@ pub struct NameGetBulkQuery {
6066
fresh: FreshQuery,
6167
}
6268

69+
/// /bulk/n
70+
///
71+
/// Here is an example of a valid request that looks up multiple names:
72+
/// ```url
73+
/// /bulk/n?names[]=luc.eth&names[]=nick.eth&names[]=helgesson.eth&names[]=irc.eth&names[]=khori.eth&names[]=v3x.eth
74+
/// ```
6375
#[utoipa::path(
6476
get,
6577
tag = "Bulk Profiles",
@@ -94,7 +106,7 @@ pub async fn get_bulk(
94106

95107
/// /sse/n
96108
///
97-
/// Here is an example of a valid request that looks up multiple names.
109+
/// Here is an example of a valid request that looks up multiple names:
98110
/// ```url
99111
/// /sse/n?names[]=luc.eth&names[]=nick.eth&names[]=helgesson.eth&names[]=irc.eth&names[]=khori.eth&names[]=v3x.eth
100112
/// ```

server/src/routes/universal.rs

+12-1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ use crate::routes::{profile_http_error_mapper, validate_bulk_input, FreshQuery,
2323
/// /u/{name_or_address}
2424
///
2525
/// The Universal Endpoint supports looking up both names and addresses.
26+
///
27+
/// Here is an example of a valid request that looks up an address or name:
28+
/// ```url
29+
/// /u/luc.eth
30+
/// /u/0x225f137127d9067788314bc7fcc1f36746a3c3B5
31+
/// ```
2632
///
2733
/// You can also use the [useProfile](https://github.com/v3xlabs/use-enstate/blob/master/src/hooks/useProfile.ts) hook from [use-enstate](https://github.com/v3xlabs/use-enstate).
2834
#[utoipa::path(
@@ -72,6 +78,11 @@ pub struct UniversalGetBulkQuery {
7278
///
7379
/// The Universal Endpoint supports looking up both names and addresses.
7480
///
81+
/// Here is an example of a valid request that looks up multiple names:
82+
/// ```url
83+
/// /bulk/u?queries[]=luc.eth&queries[]=nick.eth&queries[]=helgesson.eth&queries[]=irc.eth&queries[]=khori.eth&queries[]=v3x.eth
84+
/// ```
85+
///
7586
/// You can also use the [useBulkProfile](https://github.com/v3xlabs/use-enstate/blob/master/src/hooks/useBulkProfile.ts) hook from [use-enstate](https://github.com/v3xlabs/use-enstate).
7687
#[utoipa::path(
7788
get,
@@ -108,7 +119,7 @@ pub async fn get_bulk(
108119
///
109120
/// The Universal Endpoint supports looking up both names and addresses.
110121
///
111-
/// Here is an example of a valid request that looks up multiple names.
122+
/// Here is an example of a valid request that looks up multiple names:
112123
/// ```url
113124
/// /sse/u?queries[]=luc.eth&queries[]=nick.eth&queries[]=helgesson.eth&queries[]=irc.eth&queries[]=khori.eth&queries[]=v3x.eth
114125
/// ```

0 commit comments

Comments
 (0)