#is there an openAPI spec of the api schemas available?

9 messages · Page 1 of 1 (latest)

vernal mulch
#

I am trying to find all of the schemas / return objects from the api, I noticed there are a lot of reused objects, for example, perfs like blitz and classical are used all over the place. It would be helpful to see all of the schemas defined so I can see where duplicates are when designing my class structure.

I am aware of the example json responses, in the api doc, It is just a little hard for me to parse those visually.

indigo rain
#

hey, there is a download button at the top of the doc

vernal mulch
#

omg ty, i don't know how I missed that

indigo rain
#

np

#

We're using OpenAPI v3.1 iirc, which not many code generator yet supports unfortunately (openAPI generators are generally in a bad shape)

cursive crater
#

the spec also isn't perfect. for many endpoints, it's pretty good but for some, it's incomplete or outdated/wrong. might be fine depending on what you want to do but if you want to generate an accurate and complete client, it won't really work.

vernal mulch
#

ok good to know!

#

mostly I just want to be able to see where I can extend my models instead of creating new ones.
for example when getting 'my profile' and getting another users profile from /users/status. The similar objects makes me think I don't need a seperate class, but it was hard for me to compare.