From 2fc3c4d4653e605c1f7516f13ded76b4ccc66ab4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gwyneth=20Pe=C3=B1a-Siguenza?= Date: Wed, 3 Jan 2024 17:32:23 -0500 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 231836a..ca0c8b2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -

Welcome to Learn to Cloud's Dictionary 👋

+

Welcome to Define the Cloud 👋

@@ -12,6 +12,19 @@ Definitions submitted here appear on the [Learn to Cloud](https://learntocloud.g ![img](img/Screenshot%202023-02-14%20at%205.54.22%20PM.png) +## Integrate into your own project + +Need an API for your project? Try out the DefineTheCloud API! :) + +The URL https://clouddictionary.azurewebsites.net/api/GetAllDefinitions shows you 10 definitions per page by default. However, you can use the `pageSize` URL parameter to increase the number of returned results, with a maximum of 50 per page. + +For example: + +https://clouddictionary.azurewebsites.net/api/GetAllDefinitions?pageSize=20 will display 20 results per page. +https://clouddictionary.azurewebsites.net/api/GetAllDefinitions?pageSize=30 will display 30 results per page, and so on. + +I've also implemented continuation tokens, which are returned with the data. To access subsequent pages of results, pass the token as the `continuationToken` URL parameter. This will continue the results from where the last page left off. You'll need to implement your own logic to iterate over all the pages, or as many as you require. Once no more results are available, the `continuationToken` will be null. + ## Contributing Contributions, issues and feature requests are welcome.