Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Create separate API limits page #757

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

[Docs] Create separate API limits page #757

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2fbe79d
Create api-limits.mdx
justinegeffen Nov 25, 2024
61fea84
Update api.mdx
justinegeffen Nov 25, 2024
0daeea2
Separate API limits page
justinegeffen Nov 25, 2024
70944a9
Add new page to sidebar
justinegeffen Nov 25, 2024
4f20137
Merge branch 'master' into justine-api-limits
munishchouhan Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/api-limits.mdx
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if it would be better to include this content in a section around fair usage.

This would hopefully avoid a search collision on API and give us a chance to explain the value it provides to the community.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question.

If there's there other content that we currently have, or anticipate creating, that could be used to build out a fair use section I could do that.

Alternatively, we could rename this "Usage limits" which opens it up for additional content.

Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: API limits
---

The Wave service implements API rate limits for API calls. Authenticated users have higher rate limits than anonymous users.

If an access token is provided, the following rate limits apply:

- 100 container builds per hour
- 1,000 container pulls per minute

If an access token isn't provided, the following rate limits apply:

- 25 container builds per day
- 250 container pulls per hour
14 changes: 0 additions & 14 deletions docs/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,6 @@ title: API reference

This page summarizes the API provided by the Wave container service.

**API limits**

The Wave service implements API rate limits for API calls. Authenticated users have higher rate limits than anonymous users.

If an access token is provided, the following rate limits apply:

- 100 container builds per hour
- 1,000 container pulls per minute

If an access token isn't provided, the following rate limits apply:

- 25 container builds per day
- 250 container pulls per hour

## POST `/container-token`

Deprecated endpoint allows you to submit a request to access a private container registry via Wave, or build a container image on-the-fly with a Dockerfile or Conda recipe file.
Expand Down
3 changes: 2 additions & 1 deletion docs/sidebar.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
"items": [
"cli/index",
"cli/reference",
"api"
"api",
"api-limits"
]
},
"faq"
Expand Down
Loading