Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
madebygps authored Jan 3, 2024
1 parent bb0f4fb commit 2fc3c4d
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<h1 align="center">Welcome to Learn to Cloud's Dictionary 👋 </h1>
<h1 align="center">Welcome to Define the Cloud 👋 </h1>
<p align="center">

<a href="https://twitter.com/learntocloud">
Expand All @@ -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. <br />
Expand Down

0 comments on commit 2fc3c4d

Please sign in to comment.