Skip to content

Commit e84077e

Browse files
Document public beta for 1.3.0
1 parent ef8d3ac commit e84077e

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ API key permissions for the [Django REST Framework](https://www.django-rest-fram
2727

2828
- ✌️ **Simple to use**: create, view and revoke API keys via the admin site, or use built-in helpers to create API keys programmatically.
2929
- πŸ”’ **As secure as possible**: API keys are treated with the same level of care than user passwords. They are hashed using the default password hasher before being stored in the database, and only visible at creation.
30-
- 🎨 **Customizable**: satisfy specific business requirements by building your own customized API key models, permission classes and admin panels.
30+
- 🎨 **Customizable**: satisfy specific business requirements by building your own customized API key models, permission classes and admin panels. (Currently in public beta.)
3131

3232
### Example use cases
3333

β€Ždocs/guide.mdβ€Ž

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,13 @@ API keys can be created, viewed and revoked programmatically by manipulating the
144144

145145
## Customization
146146

147+
!!! warning
148+
This section documents functionality that is currently in public beta. To use it, install this package using:
149+
150+
```bash
151+
pip install "djangorestframework-api-key==1.3.0.b0"
152+
```
153+
147154
This package provides various customization APIs that allow you to extend its basic behavior.
148155

149156
### API key models

β€Ždocs/index.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333

3434
- ✌️ **Simple to use**: create, view and revoke API keys via the admin site, or use built-in helpers to create API keys programmatically.
3535
- πŸ”’ **As secure as possible**: API keys are treated with the same level of care than user passwords. They are hashed using the default password hasher before being stored in the database, and only visible at creation.
36-
- 🎨 **Customizable**: satisfy specific business requirements by building your own customized API key models, permission classes and admin panels.
36+
- 🎨 **Customizable**: satisfy specific business requirements by building your own customized API key models, permission classes and admin panels. (Currently in public beta.)
3737

3838
!!! info
3939
There are important security aspects you need to consider before switching to an API key access control scheme. See [Security caveats](security.md#caveats).

0 commit comments

Comments
Β (0)