kacaii.dev / possum
🐀 ATproto library for gleam
atproto library gleam
35
Fork 0

Configure Feed

Select the types of activity you want to include in your feed.

possum: add response examples

kacaii.dev (Jun 30, 2026, 11:53 AM -0300) a261b444 481c4822

test.yml
+78 -2
+78 -2
src/possum.gleam
··· 191 191 /// ) 192 192 /// ``` 193 193 /// 194 + /// ## Response 195 + /// 196 + /// ```json 197 + /// { 198 + /// "did": "string", 199 + /// "email": "string", 200 + /// "active": true, 201 + /// "didDoc": null, 202 + /// "handle": "string", 203 + /// "status": "takendown", 204 + /// "accessJwt": "string", 205 + /// "refreshJwt": "string", 206 + /// "emailConfirmed": true, 207 + /// "emailAuthFactor": true 208 + /// } 209 + /// ``` 210 + /// 194 211 /// Endpoint Docs: [/xrpc/com.atproto.server.createSession](https://endpoints.bsky.app/#bluesky-app/tag/comatprotoserver/POST/xrpc/com.atproto.server.createSession) 195 212 pub fn create_session( 196 213 request: request.Request(_), ··· 240 257 /// |> possum.refresh_session("refresh-token") 241 258 /// ``` 242 259 /// 260 + /// ## Response 261 + /// 262 + /// ```json 263 + /// { 264 + /// "did": "string", 265 + /// "email": "string", 266 + /// "active": true, 267 + /// "didDoc": null, 268 + /// "handle": "string", 269 + /// "status": "takendown", 270 + /// "accessJwt": "string", 271 + /// "refreshJwt": "string", 272 + /// "emailConfirmed": true, 273 + /// "emailAuthFactor": true 274 + /// } 275 + /// ``` 276 + /// 243 277 /// Endpoint Docs: [/xrpc/com.atproto.server.refreshSession](https://endpoints.bsky.app/#bluesky-app/tag/comatprotoserver/POST/xrpc/com.atproto.server.refreshSession) 244 278 pub fn refresh_session( 245 279 request: request.Request(_), ··· 267 301 /// |> possum.get_session_info 268 302 /// ``` 269 303 /// 304 + /// ## Response 305 + /// 306 + /// ```json 307 + /// { 308 + /// "did": "string", 309 + /// "email": "string", 310 + /// "active": true, 311 + /// "didDoc": null, 312 + /// "handle": "string", 313 + /// "status": "takendown", 314 + /// "emailConfirmed": true, 315 + /// "emailAuthFactor": true 316 + /// } 317 + /// ``` 318 + /// 270 319 /// Endpoint Docs: [/xrpc/com.atproto.server.getSession](https://endpoints.bsky.app/#bluesky-app/tag/comatprotoserver/POST/xrpc/com.atproto.server.getSession) 271 320 pub fn get_session_info(request: request.Request(_)) -> request.Request(_) { 272 321 request ··· 335 384 |> request.set_query([#("repo", did)]) 336 385 } 337 386 338 - /// Get a single record from a repository. 387 + /// Get a single record from a repository. Does not require auth. 339 388 /// 340 389 /// A **record key** (rkey) is used to name and reference an individual record 341 390 /// withing the same collection of an repository. ··· 363 412 /// ) 364 413 /// ``` 365 414 /// 415 + /// ## Response 416 + /// 417 + /// ```json 418 + /// { 419 + /// "cid": "string", 420 + /// "uri": "string", 421 + /// "value": null 422 + /// } 423 + /// ``` 424 + /// 366 425 /// Endpoint Docs: [/xrpc/com.atproto.repo.getRecord](https://endpoints.bsky.app/#bluesky-app/tag/comatprotorepo/GET/xrpc/com.atproto.repo.getRecord) 367 426 /// Documentation: [atproto.com](https://atproto.com/specs/record-key) 368 427 pub fn get_record( ··· 409 468 /// ) 410 469 /// ``` 411 470 /// 471 + /// ## Response 472 + /// 473 + /// ```json 474 + /// { 475 + /// "cursor": "string", 476 + /// "records": [ 477 + /// { 478 + /// "cid": "string", 479 + /// "uri": "string", 480 + /// "value": null 481 + /// } 482 + /// ] 483 + /// } 484 + /// ``` 485 + /// 412 486 /// Endpoint Docs: [/xrpc/com.atproto.repo.listRecords](https://endpoints.bsky.app/#bluesky-app/tag/comatprotorepo/GET/xrpc/com.atproto.repo.listRecords) 413 487 pub fn list_records( 414 488 request: request.Request(_), ··· 450 524 /// Including the document's relation to a publication if applicable, 451 525 /// a path to the document, and more information like a document's complete contents. 452 526 /// 527 + /// This function os a wrapper around `list_records`. 528 + /// 453 529 /// ## Examples 454 530 /// 455 531 /// ```gleam ··· 459 535 /// let request = 460 536 /// request.new() 461 537 /// |> request.set_host("personal.data-server.pds") 462 - /// |> possum.list_standard_documents(did, option.None) 538 + /// |> possum.list_standard_documents(did, limit: option.None) 463 539 /// ``` 464 540 /// 465 541 /// Documentation: [standard.site](https://standard.site/)