The API docs on join-lemmy.org are actually JavaScript SDK docs, not API docs. I want to build an API client in a different language, not write a JavaScript thing using the SDK, and would prefer not to plumb the JS SDK code to understand the API.

Is there somewhere that has a language-agnostic description of Lemmy’s APIs?

  • Dessalines@lemmy.ml
    01·
    3 years ago

    For example, the full documentation for deleteCommunity() is “Delete a community.” In what circumstances may I delete a community? What authentication needs to be performed before this function is called? What response should I expect if the deletion failed?

    Click on the form, and it tells you exactly what are the required fields, and the output type for what you’re getting back.

    There’s no place to see everything about an endpoint: its URL, request/response types, etc.

    Except for the exact endpoints (which are linked directly in every method description), every single input and output is fully expandable and described.

    It doesn’t require reverse engineering anything, just click a few links.

    • ieure@lemmy.mlOP
      2·
      3 years ago

      Well, I can see that this isn’t going to be a productive conversation, so I’m out.

      I’ll just leave you with this: you have two people here who agree that docs need significant work, and I gave a detailed list of specific things that need addressing. Ignoring half the issues to say, essentially, “you’re wrong, just click around” is not helpful.