Skip to content

Commit

Permalink
🔥 Remove WebSocket support, reduce some of the noise generally in pre…
Browse files Browse the repository at this point in the history
…paration for refactoring. (#234)
  • Loading branch information
jordaneremieff authored Feb 12, 2022
1 parent 4b4cafd commit 8505788
Show file tree
Hide file tree
Showing 37 changed files with 27 additions and 2,014 deletions.
5 changes: 1 addition & 4 deletions docs/adapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,10 @@ handler = Mangum(
lifespan="auto",
api_gateway_base_path=None,
text_mime_types=None,
dsn=None,
api_gateway_endpoint_url=None,
api_gateway_region_name=None
)
```

All arguments are optional, but some may be necessary for specific use-cases (e.g. dsn is only required for WebSocket support).
All arguments are optional.

## Configuring an adapter instance

Expand Down
4 changes: 1 addition & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@ Mangum is an adapter for using [ASGI](https://asgi.readthedocs.io/en/latest/) ap

## Features

- API Gateway support for [HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html), [REST](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-rest-api.html), and [WebSocket](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html) APIs.

- Multiple storage backend interfaces for managing WebSocket connections.
- API Gateway support for [HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) and [REST](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-rest-api.html) APIs.

- Compatibility with ASGI application frameworks, such as [Starlette](https://www.starlette.io/), [FastAPI](https://fastapi.tiangolo.com/), and [Quart](https://pgjones.gitlab.io/quart/).

Expand Down
300 changes: 0 additions & 300 deletions docs/websockets.md

This file was deleted.

Loading

0 comments on commit 8505788

Please sign in to comment.