RTDIP University Course Design and API Content (rtdip#800)

* add university page to docs Signed-off-by: Chloe Ching <[email protected]> * univeristy page updates Signed-off-by: Chloe Ching <[email protected]> * updated css to center alignments Signed-off-by: Chloe Ching <[email protected]> * updates for university course icons Signed-off-by: Chloe Ching <[email protected]> * essentials page updates Signed-off-by: Chloe Ching <[email protected]> * course section Signed-off-by: Chloe Ching <[email protected]> * updates Signed-off-by: Chloe Ching <[email protected]> * css updates for course page Signed-off-by: Chloe Ching <[email protected]> * finalised course section and added api md docs Signed-off-by: Chloe Ching <[email protected]> * update essentials page Signed-off-by: Chloe Ching <[email protected]> * updates to essentials css and logos Signed-off-by: Chloe Ching <[email protected]> * add api overview documentation for university course Signed-off-by: Chloe Ching <[email protected]> * updates Signed-off-by: Chloe Ching <[email protected]> * updates to docs for university course Signed-off-by: Chloe Ching <[email protected]> * added api content for university course Signed-off-by: Chloe Ching <[email protected]> * add univeristy course badge Signed-off-by: Chloe Ching <[email protected]> * update api exercise Signed-off-by: Chloe Ching <[email protected]> * remove overview title Signed-off-by: Chloe Ching <[email protected]> * fix test warnings Signed-off-by: Chloe Ching <[email protected]> * fix warnings Signed-off-by: Chloe Ching <[email protected]> --------- Signed-off-by: Chloe Ching <[email protected]>
GBBBAS · Aug 9, 2024 · a2686d9 · a2686d9
1 parent 5a04ecc
commit a2686d9
Show file tree

Hide file tree

Showing 36 changed files with 1,166 additions and 91 deletions.
diff --git a/docs/api/authentication.md b/docs/api/authentication.md
@@ -1,3 +1,5 @@
+<!-- --8<-- [start:authentication] -->
+
 # Authentication 
 
 RTDIP REST APIs require Azure Active Directory Authentication and passing the token received as an `authorization` header in the form of a Bearer token. An example of the REST API header is `Authorization: Bearer <<token>>`
@@ -17,4 +19,6 @@ If a developer or business user would like to leverage the RTDIP REST API suite,
 
 Ensure to install the relevant package and obtain a token.
 
-See the [examples](./examples.md) section to see various authentication methods implemented.
+See the [examples](https://www.rtdip.io/api/examples/) section to see various authentication methods implemented.
+
+<!-- --8<-- [end:authentication] -->
diff --git a/docs/api/overview.md b/docs/api/overview.md
@@ -1,5 +1,11 @@
 <center> ![rest](images/rest-api-logo.png){width=50%} </center>
 
+<!-- --8<-- [start:restapi] -->
+
 # RTDIP REST APIs
 
-RTDIP provides REST API endpoints for querying data in the platform. The APIs are a wrapper to the python [RTDIP SDK](../sdk/overview.md) and provide similar functionality for users and applications that are unable to leverage the python RTDIP SDK. It is recommended to read the [RTDIP SDK documentation](../sdk/overview.md) and in particular the [Functions](../sdk/code-reference/query/functions/time_series/resample.md) section for more information about the options and logic behind each API.
+RTDIP provides REST API endpoints for querying data in the platform. The APIs are a wrapper to the python [RTDIP SDK](https://www.rtdip.io/sdk/overview/) and provide similar functionality for users and applications that are unable to leverage the python RTDIP SDK. It is recommended to read the [RTDIP SDK documentation](https://www.rtdip.io/sdk/overview/) and in particular the [Functions](https://www.rtdip.io/sdk/queries/functions/) section for more information about the options and logic behind each API. 
+
+RTDIP API's are designed with the intention of running small to medium queries, rather than large queries to reduce network latency, increase performance and maintainability.  
+
+<!-- --8<-- [end:restapi] -->
diff --git a/docs/api/rest_apis.md b/docs/api/rest_apis.md
@@ -1,15 +1,28 @@
+
 # RTDIP REST API Endpoints
 
 RTDIP REST API documentation is available in a number of formats, as described below. 
 
 <center> ![rest](images/open-api.png){width=50%} </center>
 
+<!-- --8<-- [start:openapi] -->
+
 RTDIP REST APIs are built to OpenAPI standard 3.0.2. You can obtain the OpenAPI JSON schema at the following endpoint of your deployed APIs `https://{domain name}/api/openapi.json`
 
+<!-- --8<-- [end:openapi] -->
+
 <center> ![rest](images/swagger.png){width=50%} </center>
 
+<!-- --8<-- [start:swagger] -->
+
 It is recommended to review the **Swagger** documentation that can be found at the following endpoint of your deployed APIs `https://{domain name}/docs` for more information about the parameters and options for each API. It is also possible to try out each API from this link.
 
+<!-- --8<-- [end:swagger] -->
+
 <center> ![rest](images/redoc-logo.png){width=50%} </center>
 
-Additionally, further information about each API can be found in Redoc format at  the following endpoint of your deployed APIs `https://{domain name}/redoc`
+<!-- --8<-- [start:redoc] -->
+
+Additionally, further information about each API can be found in Redoc format at  the following endpoint of your deployed APIs `https://{domain name}/redoc`
+
+<!-- --8<-- [end:redoc] -->