search

yugabyte / yugabyte-db

YugabyteDB - the cloud native distributed SQL database for mission-critical applications.
https://www.yugabyte.com
Other
9.08k stars 1.09k forks source link

[Docs] Platform API endpoint does not give output as expected #12213

Open Anagha-Damodaran opened 2 years ago

Anagha-Damodaran commented 2 years ago

Description

When hitting the Platform API getting output for the endpoint /customers//universes/ however not getting output for any levels below that. As per the documentation https://api-docs.yugabyte.com/docs/yugabyte-platform/ZG9jOjIwMDY0MTA4-platform-api-overview#url-schema, the endpoint /customers//universes//clusters/primary is a valid one.

Can we please add more details to the documentation on the scenario where the endpoint /customers//universes//clusters/primary is valid?

Looks like the above endpoint is valid only for clusters with read replica enabled. However, the documentation is unclear on that part.

Similarly, the document mentions /customers//providers//nodes as valid. But will need to use /customers//providers//nodes/list to get the results.

polarweasel commented 2 years ago

@sb-yb can you please triage?

sb-yb commented 2 years ago

@Anagha-Damodaran Please look at the examples: https://github.com/yugabyte/yugabyte-db/blob/master/managed/api-examples/python-simple/create-universe.ipynb

And https://github.com/yugabyte/yugabyte-db/blob/master/managed/api-examples/python-simple/edit-universe.ipynb

@polarweasel Can we add these two examples on api-docs.yugabyte.com website? Instead of Jupyter Notebooks i.e. Having pages like Examples

More examples can then point to github the way we do for Jupyter Notebooks page.