search

GRESB / api-docs

http://gresb.github.io/api-docs/
4 stars 0 forks source link

"Update the request examples in the api-docs for the 2022 reporting period" #89

Closed naincygoyal closed 2 years ago

naincygoyal commented 2 years ago

I have made these changes https://github.com/GRESB/api-docs/issues/88#issuecomment-1049779332 in https://github.com/GRESB/api-docs/blob/master/source/includes/_assets.md

joeyhorst commented 2 years ago

@naincygoyal what is important and needs to be done in the short run is informing the user that they need to create an account in portal.gresb.com and use api.gresb.com for their base URL when making a request.

Soon we will remove the UI from api.grebs.com.

Find all instances like

https://github.com/GRESB/api-docs/blob/master/source/includes/_oauth2.md?plain=1#L12-L14

naincygoyal commented 2 years ago

@joeyhorst I have incorporated the review comments , please have a look into it once and let me know if any modification require. https://github.com/GRESB/api-docs/commit/58a2577f1915f1870d08bf29c1a273994b37d276

joeyhorst commented 2 years ago

@naincygoyal you will have to resolve my comments and then push your new commits to this PR in order for me to do a second review.

naincygoyal commented 2 years ago

@joeyhorst These are the new changes which I made please review it once and let me know if any further changes are required.

https://github.com/GRESB/api-docs/pull/89/commits/bce535509b90a0b2b6f52bdb68ee943b6cd5f25e

joeyhorst commented 2 years ago

@naincygoyal https://github.com/GRESB/api-docs/commit/bce535509b90a0b2b6f52bdb68ee943b6cd5f25e#r67953623

joeyhorst commented 2 years ago

unfortunately we still have a bunch of places where we still refer to api.gresb.com as UI - we need to make the split between UI and API endpoints clear to the user.

I'll follow up with another issue we can tackle @jjpai

image image