Write the access policy page for the AQS docs site
URL: /documentation/access-policy
Contents:
Source:
| Title | Reference | Author | Source Branch | Dest Branch | |
|---|---|---|---|---|---|
| Update access policy - remove rate limits | repos/generated-data-platform/aqs/analytics-api!28 | kbach | no-rate-limits | main | |
| Add access policy | repos/generated-data-platform/aqs/analytics-api!11 | apaskulin | access | main |
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Stalled | None | T324931 Clean up open RESTBase related tickets | |||
| In Progress | None | T262315 <CORE TECHNOLOGY> API Migration & RESTBase Sunset | |||
| In Progress | None | T263489 AQS 2.0 | |||
| Open | apaskulin | T288664 AQS 2.0 user documentation | |||
| Open | VirginiaPoundstone | T364799 Write access policy for AQS docs |
apaskulin updated https://gitlab.wikimedia.org/repos/generated-data-platform/aqs/analytics-api/-/merge_requests/11
Add access policy
@VirginiaPoundstone For the rate limits for AQS 2.0, I've copied the per-endpoint rate limits from the RESTBase documentation. Looking at T341569: Add support for end-point (?) rate limiting on REST-Gateway, it seems like rate limiting may not be implemented yet in the REST Gateway, but I went ahead and listed the original rate limits since no other rate limits have been decided on at this time. Let me know if this works for you. We can always update them if we decide on a new set of limits.
Alternatively, we can use similar language as the MediaWiki APIs ("There is no fixed limit on requests to the API, but your client may be blocked if you endanger the stability of a site. To stay within a safe request rate, wait for each request to finish before sending another request.").
kbach merged https://gitlab.wikimedia.org/repos/generated-data-platform/aqs/analytics-api/-/merge_requests/11
Add access policy
This guide is now live! Moving to Sign Off and assigning to Virginia for a +1 on my previous comment: https://phabricator.wikimedia.org/T364799#9882524
I wondered where you got the rate limit stats from.
@SGupta please confirm that there is no rate limiting. If there is none, please outline work required to set one. I believe it would be a request to for rate limit to be applied in the RESTGatway, but want to confirm.
If there is no rate limiting, and we are not able to add it easily, then we should use the borrowed language: "There is no fixed limit on requests to the API, but your client may be blocked if you endanger the stability of a site. To stay within a safe request rate, wait for each request to finish before sending another request."
@VirginiaPoundstone I am not aware of any rate limits on AQS 2.0 service , tagging @hnowlan for confirmation.
kbach opened https://gitlab.wikimedia.org/repos/generated-data-platform/aqs/analytics-api/-/merge_requests/28
Update access policy - remove rate limits
apaskulin merged https://gitlab.wikimedia.org/repos/generated-data-platform/aqs/analytics-api/-/merge_requests/28
Update access policy - remove rate limits
Doc have been updated to use the more general language since there are no rate limits in place. This can be changed later if rate limits are put in place.