• MV (Jerboa dev)@programming.dev
    2·
    5 months ago

    I do not see how critisms for the JS API docs are relevant for my openapi documentation.

    This documentation aims to solve all those problems in a language agnostic way. It descibes the endpoints, the request object, the status, the response object, the authentication needed in visual/text. It allows you test it right from the browser, allows you to copy a working curl command, search for endpoints based on keywords, allows you to import the entire spec into postman/alts.

    I ve never had any problems with CF instances but I mostly test with voyager.lemmy.ml

    • refalo@programming.dev
      2·
      5 months ago

      Yours is a little bit easier to read, but my main problems remain the same. Here’s some initial comments looking at your swagger link from the perspective of a user who is brand new to the lemmy API (and doesn’t use Javascript):

      • I can’t tell what the general flow of the API usage in general is. Am I supposed to login/authorize somehow first? Some common examples, especially in at least one programming language (whether that’s curl or python or whatever) I think would go a long way to help people understand what they’re supposed to do.

      • How do I know if I need to authorize for a particular endpoint?

      • What is the entire URL for any given endpoint? It’s never really explained clearly.

      • What is this “servers” dropdown? What’s the difference between those?

      • Endpoint descriptions are often unhelpful. /user says “Get the details for a person.” It doesn’t tell me this is actually how I’m supposed to find their comments or posts. Nothing tells us this.

      • We have to guess what endpoint we might need for a lot of things. Example: /post/like is also for dislikes, but it doesn’t tell you that. It also never tells you HOW to like or dislike anything, the valid values of score do not appear to be documented. And you’re left to assume that’s the right field to even use for it.

      • What is the content type of the request supposed to be? JSON is never mentioned anywhere.

      • What are these named “parameters”? Is that a query parameter? Why does it say “object” and “(query)”? Does this parameter go in the request body instead? /user shows a parameter called “GetPersonDetails” except in reality this name is (I guess) supposed to be completely ignored, because no part of the request actually uses the string “GetPersonDetails”.

      • Schema is missing for many endpoints, like the request part of /user.

      • What are all these fields under “GetPersonDetails”? Are they all required? Only some? It doesn’t say anything about it.

      • Many of the possible error codes are undocumented.

      There’s probably more but that’s the main stuff I think.