Commit a014f3fb authored by Amy Qualls's avatar Amy Qualls

Technical writing revisions: tone and style

Revises the page for the new feature. Adds crosslinks to the API
page, and fixes a glaring problem with the API page so the crosslink
has somewhere appropriate to go. (Don't use bolding instead of
subheaders!)
parent 3da4af85
......@@ -97,8 +97,8 @@ On self-managed GitLab, by default this feature is not available. To make it ava
ask an administrator to [enable the `files_api_throttling` flag](../administration/feature_flags.md). On GitLab.com, this feature is available but can be configured by GitLab.com administrators only.
The feature is not ready for production use.
This setting limits the request rate on the Packages API per user or IP. For more information, see
[Files API Rate Limits](../user/admin_area/settings/files_api_rate_limits.md).
This setting limits the request rate on the Packages API per user or IP address. For more information, read
[Files API rate limits](../user/admin_area/settings/files_api_rate_limits.md).
- **Default rate limit**: Disabled by default.
......
......@@ -7,9 +7,11 @@ type: reference, api
# Repository files API **(FREE)**
**CRUD for repository files**
You can fetch, create, update, and delete files in your repository with this API.
You can also [configure rate limits](../user/admin_area/settings/files_api_rate_limits.md)
for this API.
**Create, read, update, and delete repository files using this API**
## Available scopes for personal access tokens
The different scopes available using [personal access tokens](../user/profile/personal_access_tokens.md) are depicted
in the following table.
......@@ -19,8 +21,6 @@ in the following table.
| `read_repository` | Allows read-access to the repository files. |
| `api` | Allows read-write access to the repository files. |
> `read_repository` scope was [introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/23534) in GitLab 11.6.
## Get file from repository
Allows you to receive information about file in repository like name, size,
......
......@@ -5,25 +5,41 @@ info: To determine the technical writer assigned to the Stage/Group associated w
type: reference
---
# Files API Rate Limits **(FREE SELF)**
# Files API rate limits **(FREE SELF)**
Rate limiting is a common technique used to improve the security and durability of a web
application. For more details, see [Rate limits](../../../security/rate_limits.md). General user and
IP rate limits can be enforced from the top bar at
**Menu > Admin > Settings > Network > User and IP rate limits**.
For more details, see [User and IP rate limits](user_and_ip_rate_limits.md).
To improve the security and durability of your web application, you can enforce
[rate limits](../../../security/rate_limits.md). You can configure general settings
for [user and IP rate limits](user_and_ip_rate_limits.md).
You can fetch, create, update, and delete files through the [Repository files API](../../../api/repository_files.md).
The [Repository files API](../../../api/repository_files.md) enables you to
fetch, create, update, and delete files in your repository.
You can define specific rate limits for the Files API in
**Menu > Admin > Settings > Network > Files API Rate Limits**:
## Define Files API rate limits
- Unauthenticated Files API requests
- Authenticated Files API requests
Prerequisite:
These limits are disabled by default. When enabled, they supersede the general user and IP rate
limits for requests to the Files API. You can therefore keep the general user and IP rate limits,
and increase (if necessary) the rate limits for the Files API.
- You must have the Administrator role for your instance.
You can define rate limits for authenticated and unauthenticated Files API
requests:
1. On the top bar, select **Menu > Admin**.
1. In the left sidebar, select **Settings > Network**, and expand **Files API Rate Limits**:
- Unauthenticated Files API requests
- Authenticated Files API requests
Rate limits for the Files API are disabled by default. When enabled, they supersede
the general user and IP rate limits for requests to the
[Repository files API](../../../api/repository_files.md). You can therefore
keep the general user and IP rate limits, and increase (if necessary) the rate limits
for the Files API.
Besides this precedence, there are no differences in functionality compared to the general user and
IP rate limits. For more details, see [User and IP rate limits](user_and_ip_rate_limits.md).
## Resources
- [Rate limits](../../../security/rate_limits.md)
- [Repository files API](../../../api/repository_files.md)
- [User and IP rate limits](user_and_ip_rate_limits.md)
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment