...
Sorry. That's not what I mean by "documentation". It's certainly non-linear. I don't know how to "read" this site to gain an understanding. It's kinda sparse:
GET /v2/adjustments > Implementation Notes: Fetches a list of adjustments.
GET /v2/reportCategories > Implementation Notes: Fetches a list of report categories.
...
Hm, I think swagger documentation is pretty standard among APIs I've worked with before. I'm pretty sure it's all they have.
...
"Swagger Documentation" is a special class of documentation for sure; Nobody likes writing documentation.
Isn't that the point of an API though? To be a black box? The example you provide is fairly simple: you hit these endpoints and get this kind of data.
If you need to add data to one endpoint and see how that travels to other endpoints, that makes sense as to why you want documentation. In that case, a product / API tutorial or recipe (like the author suggests) might be useful.
... Hi, I reaching out to to ask if I could get my hands on some documentation because the API is somewhat a black box to me.
... The api documentation for [product] can be found here: https://api.[product].com/
... Sorry. That's not what I mean by "documentation". It's certainly non-linear. I don't know how to "read" this site to gain an understanding. It's kinda sparse:
... Hm, I think swagger documentation is pretty standard among APIs I've worked with before. I'm pretty sure it's all they have.... "Swagger Documentation" is a special class of documentation for sure; Nobody likes writing documentation.
Talk about insider (them)/outsider (me).