Skip to content

Commit

Permalink
Merge pull request #1 from skysqlinc/apidocs-url
Browse files Browse the repository at this point in the history
Update API docs website URL
  • Loading branch information
vjr authored Jan 30, 2024
2 parents 9400dbe + ddeb478 commit ff24e64
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This walkthrough explains how to launch database services and manage the lifecyc

### **Step 2: Use Swagger docs to try out the APIs**

You can use the API Documentation [here](https://docs.skysql.mariadb.com/) and directly try out the APIs in your browser.
You can use the API Documentation [here](https://apidocs.skysql.com/) and directly try out the APIs in your browser.

All you need is to click ‘Authorize’ and type in `Bearer <supply your API key here>`

Expand Down Expand Up @@ -234,5 +234,5 @@ EOF
## Resources
- [API Documentation](https://docs.skysql.mariadb.com/)
- [API Reference Documentation](https://mariadb.com/docs/skysql-dbaas/ref/skynr/)
- [API Documentation](https://apidocs.skysql.com/)
- [API Reference Documentation](https://mariadb.com/docs/skysql-dbaas/ref/skynr/)
Original file line number Diff line number Diff line change
Expand Up @@ -561,5 +561,5 @@ With **macOS**, manually install the provider on the target system by performin
- [GitHub Project](https://github.com/mariadb-corporation/terraform-provider-skysql)
- [Example Terraform Configuration Files](https://github.com/mariadb-corporation/terraform-provider-skysql/tree/main/examples)
- [Terraform Registry](https://registry.terraform.io/providers/mariadb-corporation/skysql)
- [API Documentation](https://docs.skysql.mariadb.com/)
- [API Reference Documentation](https://mariadb.com/docs/skysql-dbaas/ref/skynr/)
- [API Documentation](https://apidocs.skysql.com/)
- [API Reference Documentation](https://mariadb.com/docs/skysql-dbaas/ref/skynr/)
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The MariaDB SkySQL DBaaS API is a REST API that can perform operations in MariaDB SkySQL using automation.

!!! Note
The easiest way to get started with the API is to use [this swagger Docs](https://docs.skysql.mariadb.com). Just generate your API key as described on this page, Click ‘Authorize’ and enter ‘Bearer <yourAPI Key> and try out any of the APIs.**
The easiest way to get started with the API is to use [this swagger Docs](https://apidocs.skysql.com). Just generate your API key as described on this page, Click ‘Authorize’ and enter ‘Bearer <yourAPI Key> and try out any of the APIs.**


## **Supported Endpoints**
Expand Down Expand Up @@ -67,4 +67,4 @@ The supported endpoints are as follows:
| https://mariadb.com/docs/skysql-dbaas/ref/skynr/api/slash_provisioning_slash_v1_slash_topologies_slash_ocb_topology_name_ccb_slash_nodes/https://mariadb.com/docs/skysql-dbaas/ref/skynr/api/slash_provisioning_slash_v1_slash_topologies_slash_ocb_topology_name_ccb_slash_nodes/ | GET | Read Topology Node Options |
| https://mariadb.com/docs/skysql-dbaas/ref/skynr/api/slash_provisioning_slash_v1_slash_topologies_slash_ocb_topology_name_ccb_slash_options/https://mariadb.com/docs/skysql-dbaas/ref/skynr/api/slash_provisioning_slash_v1_slash_topologies_slash_ocb_topology_name_ccb_slash_options/ | GET | Read Topology Options |
| https://mariadb.com/docs/skysql-dbaas/ref/skynr/api/slash_provisioning_slash_v1_slash_topologies_slash_ocb_topology_name_ccb_slash_storage-sizes/https://mariadb.com/docs/skysql-dbaas/ref/skynr/api/slash_provisioning_slash_v1_slash_topologies_slash_ocb_topology_name_ccb_slash_storage-sizes/ | GET | Read Topology Storage Sizes |
| https://mariadb.com/docs/skysql-dbaas/ref/skynr/api/slash_provisioning_slash_v1_slash_versions/ | GET | Read Software Versions |
| https://mariadb.com/docs/skysql-dbaas/ref/skynr/api/slash_provisioning_slash_v1_slash_versions/ | GET | Read Software Versions |
Original file line number Diff line number Diff line change
Expand Up @@ -1850,7 +1850,7 @@ <h3 id="step-1-generate-api-key"><strong>Step 1: Generate API Key</strong></h3>
</li>
</ol>
<h3 id="step-2-use-swagger-docs-to-try-out-the-apis">Step 2: Use Swagger docs to try out the APIs</h3>
<p>You can use the API Documentation <a href="https://docs.skysql.mariadb.com/">here</a> and directly try out the APIs in your browser. </p>
<p>You can use the API Documentation <a href="https://apidocs.skysql.com/">here</a> and directly try out the APIs in your browser. </p>
<p>All you need is to click ‘Authorize’ and type in <code>Bearer &lt;supply your API key here&gt;</code></p>
<p>Alternatively, you can follow the steps below to launch a DB … </p>
<h2 id="pre-requisites-for-code-below">Pre-requisites for code below</h2>
Expand Down Expand Up @@ -2021,7 +2021,7 @@ <h3 id="step-7-save-connection-information-optional"><strong>Step 7: Save Connec
</ol>
<h1 id="resources">Resources</h1>
<ul>
<li><a href="https://docs.skysql.mariadb.com/">API Documentation</a></li>
<li><a href="https://apidocs.skysql.com/">API Documentation</a></li>
<li><a href="https://mariadb.com/docs/skysql-dbaas/ref/skynr/">API Reference Documentation</a></li>
</ul>

Expand Down Expand Up @@ -2160,4 +2160,4 @@ <h1 id="resources">Resources</h1>


</body>
</html>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -2325,7 +2325,7 @@ <h1 id="resources">Resources</h1>
<li><a href="https://github.com/mariadb-corporation/terraform-provider-skysql">GitHub Project</a></li>
<li><a href="https://github.com/mariadb-corporation/terraform-provider-skysql/tree/main/examples">Example Terraform Configuration Files</a></li>
<li><a href="https://registry.terraform.io/providers/mariadb-corporation/skysql">Terraform Registry</a></li>
<li><a href="https://docs.skysql.mariadb.com/">API Documentation</a></li>
<li><a href="https://apidocs.skysql.com/">API Documentation</a></li>
<li><a href="https://mariadb.com/docs/skysql-dbaas/ref/skynr/">API Reference Documentation</a></li>
</ul>

Expand Down Expand Up @@ -2464,4 +2464,4 @@ <h1 id="resources">Resources</h1>


</body>
</html>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -1885,7 +1885,7 @@ <h1 id="rest-api-reference">REST API Reference</h1>
<p>The MariaDB SkySQL DBaaS API is a REST API that can perform operations in MariaDB SkySQL using automation.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The easiest way to get started with the API is to use <a href="https://docs.skysql.mariadb.com">this swagger Docs</a>. Just generate your API key as described on this page, Click ‘Authorize’ and enter ‘Bearer <yourAPI Key> and try out any of the APIs.**</p>
<p>The easiest way to get started with the API is to use <a href="https://apidocs.skysql.com">this swagger Docs</a>. Just generate your API key as described on this page, Click ‘Authorize’ and enter ‘Bearer <yourAPI Key> and try out any of the APIs.**</p>
</div>
<h2 id="supported-endpoints"><strong>Supported Endpoints</strong></h2>
<p>The supported endpoints are as follows:</p>
Expand Down Expand Up @@ -2300,4 +2300,4 @@ <h2 id="supported-endpoints"><strong>Supported Endpoints</strong></h2>


</body>
</html>
</html>

0 comments on commit ff24e64

Please sign in to comment.