Case study in APIs
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 20/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- api
Research direction
The issue contains API request and response examples but names no repository file, test, or entry point to change. Start by locating the code that handles the shown post-creation response; done would require a maintainer-defined higher-level result that exposes the created post location and addresses the broader API concerns.
Written by the indexing model from the issue text.
Description
This is the info that my app sends to a server that then converts it to Bluesky's internal language as the arguments for a call that will create a new post. These are standard names for these things that any experience programmer would immediately recognize. Users would recognize them too, except perhaps urlsite.
{
"title": "",
"description": "Room for One More on Mount Rushmore?",
"mailaddress": "",
"password": "",
"urlsite": "https://bsky.social/",
"link": "https://politicalwire.com/2025/06/29/room-for-one-more-on-mount-rushmore/"
}
And this is what comes back.
{
"uri": "at://did:plc:zxb2lwpxo4axkkkgjwqand24/app.bsky.feed.post/3lsqtoowg2h2h",
"cid": "bafyreifhet2772xmic24qr4xbui4l5lllvgek2a7kmmchojwwkufvzalci",
"commit": {
"cid": "bafyreicjjsd4ixlezubezaxzfaqxxpwlvoxdqwyxblnme5uh6ehklxth3a",
"rev": "3lsqtoowpsx2h"
},
"validationStatus": "valid"
}
Some of the terms mean something, like URI and commit, but their values don't mean anything to me, don't shed any light on what the result was except "validationStatus": "valid" seems to say "it worked." :-)
And nowhere in this package is the one piece of info every freaking app would need after posting something -- where the F did you put it!??
I don't have a problem with detailed internal info coming back from a query. I know APIs are used for lots of applications. But this is a problem I've seen repeatedly in their API, they push the work out to the developer where they for sure have the code internally to do it, and could factor out the work, instead of making us all implement what we're sure to need, do it once and provide a higher level interface.
Just some feedback for the Bluesky folk, and a caution when designing your own APIs, write some code that runs against your API, you'd see these problems right away.
- Dominant language
- HTML
- Stars
- 134
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from scripting/Scripting-News
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
scripting/Scripting-News#353 · 6 comments ·
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
scripting/Scripting-News#332 · 25 comments · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
scripting/Scripting-News#362 ·
-
Matt is moved aside Open
Difficulty 5/5 Over a week Newbie friendliness 20/100
scripting/Scripting-News#361 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
scripting/Scripting-News#360 · 1 comment · 1 reaction ·
All issues in scripting/Scripting-News
Similar issues
-
bug priority:normal ready-for-dev
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
OpenHands/extensions#626 · 1 comment ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
avniproject/avni-client#2135 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
use-agent-os/agent-os#3276 ·