Skip to content

Commit

Permalink
API V1 removed from documentation or made it in the past
Browse files Browse the repository at this point in the history
  • Loading branch information
thijmengg committed Apr 17, 2024
1 parent 20e81ec commit 7992b38
Show file tree
Hide file tree
Showing 25 changed files with 8 additions and 430 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,23 +93,22 @@ In the future we should register this method in the `apps.py` file of the app, b

#### Versions
We currently have 2 versions of the API.
The first version is the `v1` API, which is the old API.
The first version is the `v1` API, which is not used and already removed.
The second version is the `v2` API, which is the new API that is actively being developed.
The `v1` API is deprecated and will be removed in the future.

#### Swagger documentation
The API has automatic documentation using Swager / OpenAPI.
This documentation is available at `/api/docs/`.

#### Authentication
`v1` uses token authentication. `v2` uses OAuth2 authentication, which is the new standard for authentication.
`v1` used to have token authentication. `v2` uses OAuth2 authentication, which is the new standard for authentication.
The OAuth2 authentication is implemented using the `django-oauth-toolkit` package.

#### Throttling
The API has throttling enabled.

#### Other (internal) APIs
Apart from the main versions (`v1` and `v2`), we also have a few specific mini-APIs that are used for specific purposes and are not really open to the public.
Apart from the main version (`v2`), we also have a few specific mini-APIs that are used for specific purposes and are not really open to the public.
These are the `calendarjs` and `facedetection` APIs. The `calendarjs` API is only used by the calendar on the website (to query events) and the `facedetection` API is used by the face detection service to post face encodings.


Expand Down
1 change: 0 additions & 1 deletion docs/activemembers.api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,4 @@ Subpackages
.. toctree::
:maxdepth: 4

activemembers.api.v1
activemembers.api.v2
34 changes: 0 additions & 34 deletions docs/activemembers.api.v1.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/announcements.api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,4 @@ Subpackages
.. toctree::
:maxdepth: 4

announcements.api.v1
announcements.api.v2
34 changes: 0 additions & 34 deletions docs/announcements.api.v1.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/events.api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,4 @@ Subpackages
:maxdepth: 4

events.api.calendarjs
events.api.v1
events.api.v2
27 changes: 0 additions & 27 deletions docs/events.api.v1.rst

This file was deleted.

18 changes: 0 additions & 18 deletions docs/events.api.v1.serializers.event_registrations.rst

This file was deleted.

26 changes: 0 additions & 26 deletions docs/events.api.v1.serializers.events.rst

This file was deleted.

16 changes: 0 additions & 16 deletions docs/events.api.v1.serializers.rst

This file was deleted.

26 changes: 0 additions & 26 deletions docs/events.api.v1.viewsets.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/members.api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,4 @@ Subpackages
:maxdepth: 4

members.api.calendarjs
members.api.v1
members.api.v2
34 changes: 0 additions & 34 deletions docs/members.api.v1.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/payments.api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,4 @@ Subpackages
.. toctree::
:maxdepth: 4

payments.api.v1
payments.api.v2
35 changes: 0 additions & 35 deletions docs/payments.api.v1.rst

This file was deleted.

26 changes: 0 additions & 26 deletions docs/payments.api.v1.serializers.rst

This file was deleted.

18 changes: 0 additions & 18 deletions docs/payments.api.v1.viewsets.rst

This file was deleted.

34 changes: 0 additions & 34 deletions docs/pizzas.api.v1.rst

This file was deleted.

Loading

0 comments on commit 7992b38

Please sign in to comment.