Case study in APIs

オープン
#322 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
20/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
領域
api

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
HTML
スター
134
フォーク
10
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

scripting/Scripting-News のほかの issue

scripting/Scripting-News の issue をすべて見る

似ている issue

Backend & API Design の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。