ambrosus / ambrosus-node-extended

Expanded reporting and organizational functionality for the Hermes node.
MIT License
5 stars 5 forks source link

New API documentation #172

Closed SigismundSchlomo closed 2 years ago

SigismundSchlomo commented 2 years ago

Why

Old api documentation was outdated

What was done

Api documentation was improved Documentation could be checked here https://amrosusnode.docs.apiary.io/#introduction/authentication Also, there is a confluence doc https://inc4net.atlassian.net/wiki/spaces/AMB/pages/175866027/Ambrosus+node+api

vitalii427 commented 2 years ago

As I see API isn't complete yet

vitalii427 commented 2 years ago

Missing endpoints: /extended /graphql /health /mobile

vitalii427 commented 2 years ago

You can use grep to find all endpoints: grep -r -A1 '@controller'|grep "'" grep -r -A1 '@http'|grep "'"

SigismundSchlomo commented 2 years ago

There is a complementary documentation on confluence https://inc4net.atlassian.net/wiki/spaces/AMB/pages/175866027/Ambrosus+node+api Also, there is a completed documentation (old link works too) https://amrosusnode.docs.apiary.io/#introduction/serialization-[serialization]

vitalii427 commented 2 years ago

/bundle2/exists/{bundleId} ?

vitalii427 commented 2 years ago

Seems that there's no /events/...

vitalii427 commented 2 years ago

I haven't checked endpoint parameters and description. Check 'em carefully pls

SigismundSchlomo commented 2 years ago

Parameters and description was proofread and some fixes were made. I hope, now this document is accurate. https://amrosusnode.docs.apiary.io/#reference/assets/assetsassetidevents

vitalii427 commented 2 years ago

/assets - availiable only for Atlas node

vitalii427 commented 2 years ago

I'm done )

vitalii427 commented 2 years ago

https://amrosusnode.docs.apiary.io/ auto updates?

SigismundSchlomo commented 2 years ago

https://amrosusnode.docs.apiary.io/ auto updates?

After merge old link will work https://ambrosus.docs.apiary.io/#introduction/

vitalii427 commented 2 years ago

Merge it )