Skip to content

Commit

Permalink
📝 Update Releases Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
awtkns committed Apr 18, 2021
1 parent 51e7dcc commit e1a4a2b
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 42 deletions.
62 changes: 32 additions & 30 deletions docs/en/docs/releases.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@

## [v0.7.0 - Advanced Dependencies ](https://github.com/awtkns/fastapi-crudrouter/releases/tag/v0.7.0) { .releases }
2021-04-18
🎉 Highlights
With the release of v0.7.0 fastapi-crudrouter now provides the ability to set custom dependencies one a per route basis; a much requested feature. Prior to this release, it was only possible to set dependencies for all the routes in the CRUDRouter. Shown below is a brief example on how limiting each route to specific access rights would work using this new feature.

## [v0.7.0 - Advanced Dependencies ](https://github.com/awtkns/fastapi-crudrouter/releases/tag/v0.7.0) { .releases }
2021-04-18
### 🎉 Highlights
With the release of v0.7.0 fastapi-crudrouter now provides the ability to set custom dependencies one a per-route basis;
a much requested feature. Prior to this release, it was only possible to set dependencies for all the routes at once.

```python
MemoryCRUDRouter(
Expand All @@ -12,18 +13,19 @@ MemoryCRUDRouter(
)
```

Shown above is a brief example on how limiting each route to specific access rights would work using this new feature.
Check out the [docs](https://fastapi-crudrouter.awtkns.com/dependencies/) for more details.

✨ Features
### ✨ Features
- Custom Dependencies Per Route #37 #59 #60 @DorskFR @jm-moreau
- Ability to Provide a List of Custom Tags for OpenAPI #57 @jm-moreau
- Improved Documentation #52
- Dark Mode for Documentation

---

## [v0.6.0 - Ormar Backend](https://github.com/awtkns/fastapi-crudrouter/releases/tag/v0.6.0) { .releases }
2021-03-26
- Dark Mode for Documentation

---

## [v0.6.0 - Ormar Backend](https://github.com/awtkns/fastapi-crudrouter/releases/tag/v0.6.0) { .releases }
2021-03-26
### 🎉 Highlights
With the release of v0.6.0 fastapi-crudrouter **now supports [ormar](https://github.com/collerek/ormar)** as an async backend! When generating routes, the OrmarCRUDRouter will automatically tie into your database using your ormar models. To use it, simply pass your ormar database model as the schema.

Expand All @@ -44,12 +46,12 @@ Check out the [docs](https://fastapi-crudrouter.awtkns.com/backends/ormar/) for
- Additional Tests for nested models #40

### 🐛 Bug Fixes
- Pagination issues when max limit was set to null @ethanhaid #42

---

## [v0.5.0 - Pagination](https://github.com/awtkns/fastapi-crudrouter/releases/tag/v0.5.0) { .releases }
2021-03-07
- Pagination issues when max limit was set to null @ethanhaid #42

---

## [v0.5.0 - Pagination](https://github.com/awtkns/fastapi-crudrouter/releases/tag/v0.5.0) { .releases }
2021-03-07
### 🎉 Highlights
With the release of v0.5.0 all CRUDRouters **now supports pagination**. All "get all" routes now accept `skip` and `limit` query parameters allowing you to easily paginate your routes. By default, no limit is set on the number of items returned by your routes. Should you wish to limit the number of items that a client can request, it can be done as shown below.

Expand All @@ -69,25 +71,25 @@ Check out the [docs](https://fastapi-crudrouter.awtkns.com/pagination/) on pagin

### 🐛 Bug Fixes
- Prefixing not available for versions of fastapi below v0.62.0 #29 #30
- Fixed an Import Issue SQLAlchemy and Integrity Errors @andreipopovici #33

---

## [v0.4.0 - Tortoise ORM Support](https://github.com/awtkns/fastapi-crudrouter/releases/tag/v0.4.0) { .releases }
2021-02-02
- Fixed an Import Issue SQLAlchemy and Integrity Errors @andreipopovici #33

---

## [v0.4.0 - Tortoise ORM Support](https://github.com/awtkns/fastapi-crudrouter/releases/tag/v0.4.0) { .releases }
2021-02-02
### ✨Features
- Full support for tortoise-orm #24
- Dynamic pk/id types for get_one, delete_one, and update_one routes #26

### 🐛 Bug Fixes
- Fixed the summary for the delete one route #16
- Fixed import errors when certain packages are not installed #21
- Improved SQLA type hinting

---

## [v0.3.0 - Initial Release](https://github.com/awtkns/fastapi-crudrouter/releases/tag/v0.3.0) { .releases }
2021-01-04
- Improved SQLA type hinting

---

## [v0.3.0 - Initial Release](https://github.com/awtkns/fastapi-crudrouter/releases/tag/v0.3.0) { .releases }
2021-01-04
<p align="center">
<img src="https://raw.githubusercontent.com/awtkns/fastapi-crudrouter/master/docs/en/docs/assets/logo.png" height="200" />
</p>
Expand Down
13 changes: 3 additions & 10 deletions docs/en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,15 @@ edit_uri: ''

theme:
name: material
# custom_dir: overrides
custom_dir: overrides
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
- scheme: default
primary: indigo
accent: amber
toggle:
icon: material/weather-sunny
name: Switch to dark mode

# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
- scheme: slate
primary: blue
accent: amber
toggle:
Expand All @@ -30,8 +25,6 @@ theme:
favicon: assets/bolt-grad.svg
language: en


# Nav
nav:
- Overview: index.md
- Schemas: schemas.md
Expand Down
4 changes: 2 additions & 2 deletions docs/en/overrides/main.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{% extends "base.html" %}

{% block announce %}
<a class="announce" href="/releases/#v060-ormar-backend" target="_blank">
🎉 v0.6.0 Released - Ormar Backend Added 🎉
<a class="announce" href="/releases/#v070-advanced-dependencies" target="_blank">
🎉 v0.7.0 Released - Advanced Dependency Support 🎉
</a>
{% endblock %}

1 comment on commit e1a4a2b

@vercel
Copy link

@vercel vercel bot commented on e1a4a2b Apr 18, 2021

Choose a reason for hiding this comment

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

Please sign in to comment.