maverick/docbrown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[deploy] Documenation: Update API Article Update Rate Limit Value to 30 (#9832)

Browse source
This commit is contained in:
Molly Struve 2020-08-17 15:17:15 -05:00 • committed by GitHub
parent ed1af664b5
commit 0646c10bf8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
app/helpers/rate_limit_checker_helper.rb
View file

@ -3,7 +3,7 @@ module RateLimitCheckerHelper
rate_limit_article_update: {
min: 1,
placeholder: 30,
description: "The number of article updates a user can make in 30 seconds"
description: "The number of article updates a user can make in 30 seconds. Please update API docs when changed."
},
rate_limit_user_update: {
min: 1,

18
docs/api_v0.yml
View file

@ -7,7 +7,7 @@ openapi: "3.0.3"
info:
title: DEV API (beta)
description: |
Access Forem articles, users and other resources via API.
For a real-world example of Forem in action, check out [DEV](https://www.dev.to).
@ -16,7 +16,7 @@ info:
Dates and date times, unless otherwise specified, must be in
the [RFC 3339](https://tools.ietf.org/html/rfc3339) format.
version: "0.7.0"
termsOfService: https://dev.to/terms
contact:
@ -214,11 +214,11 @@ components:
edited_at:
type: string
format: date-time
nullable: true
nullable: true
crossposted_at:
type: string
format: date-time
nullable: true
nullable: true
published_at:
type: string
format: date-time
@ -315,7 +315,7 @@ components:
crossposted_at:
type: string
format: date-time
nullable: true
nullable: true
published_at:
type: string
format: date-time
@ -853,14 +853,14 @@ components:
type: string
twitter_username:
type: string
nullable: true
nullable: true
github_username:
type: string
nullable: true
website_url:
type: string
format: url
nullable: true
nullable: true
profile_image:
description: Profile image (640x640)
type: string
@ -943,7 +943,7 @@ components:
website_url:
type: string
format: url
nullable: true
nullable: true
location:
type: string
nullable: true
@ -1869,7 +1869,7 @@ paths:
### Rate limiting
There is a limit of 150 requests per 30 seconds.
There is a limit of 30 requests per 30 seconds.
### Additional resources