atproto icon indicating copy to clipboard operation
atproto copied to clipboard

getFollows API Missing Expected Fields in associated Object

Open mf-rug opened this issue 2 months ago • 0 comments

Title: getFollows API Missing Expected Fields in associated Object

Description

The getFollows API endpoint does not return the complete associated object for each follow, as described in the documentation. Specifically, fields like starterPacks, lists, and feedgens, which are part of the documented schema, are missing in the API response, even when these fields are available for the same user via the getProfile endpoint.

Steps to Reproduce

  1. Use the getFollows API to fetch the follows for a user:
curl -X GET "https://<server-url>/xrpc/app.bsky.graph.getFollows?actor=<actor-handle>" \
-H "Authorization: Bearer <valid-access-token>"
  1. Check the associated field in the response for any of the returned users.
  2. Compare the output with the getProfile API for the same user:
curl -X GET "https://<server-url>/xrpc/app.bsky.actor.getProfile?actor=<user-handle>" \
-H "Authorization: Bearer <valid-access-token>"

Expected Behavior

The associated field in the getFollows response should contain the fields documented in the API schema, including:

  • starterPacks
  • lists
  • feedgens
  • labeler
  • chat

Actual Behavior

The associated field in the getFollows response only contains the chat field. Other fields, such as starterPacks, are missing, even when they are present in the getProfile response for the same user.

Example Output

Providing example for a specific user1 as screenshot. getProfile on the user1 directly returns all info in the associated field, whereas when accessing the associated user1 info via getFollows from another user2 who is following user1, the output does not contain the expected fields.

image

Proposed Solution

  • getFollows should return the full info
  • Or adjust the docs that the info is reduced

mf-rug avatar Dec 06 '24 10:12 mf-rug