Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
01015a2
docs: add Markdown code fences to docstrings
lukegalbraithrussell Aug 13, 2026
67812bc
docs: migrate API reference from HTML (pdoc3) to Markdown (pydoc-mark…
lukegalbraithrussell Aug 13, 2026
2266bf2
docs: serve package reference pages at folder URLs
lukegalbraithrussell Aug 13, 2026
23874b0
move to be within english
lukegalbraithrussell Aug 13, 2026
de6d47e
docs: fence App.start() example and target docs/english/reference
lukegalbraithrussell Aug 13, 2026
51128e2
docs: embed reference tree into _sidebar.json
lukegalbraithrussell Aug 13, 2026
c6960fc
go
lukegalbraithrussell Aug 14, 2026
2b95612
go
lukegalbraithrussell Aug 14, 2026
44bafeb
colliding paths fix
lukegalbraithrussell Aug 14, 2026
da71715
go
lukegalbraithrussell Aug 14, 2026
7bf50da
go
lukegalbraithrussell Aug 14, 2026
ab7e690
go
lukegalbraithrussell Aug 14, 2026
24fe29c
go
lukegalbraithrussell Aug 14, 2026
07ba452
toc
lukegalbraithrussell Aug 18, 2026
abe7dd9
docstrings
lukegalbraithrussell Aug 18, 2026
0669cbd
toggles
lukegalbraithrussell Aug 18, 2026
490dbde
griffe
lukegalbraithrussell Aug 20, 2026
ccfe23e
working
lukegalbraithrussell Aug 20, 2026
3b07a17
streamline
lukegalbraithrussell Aug 20, 2026
0e8f943
go
lukegalbraithrussell Aug 20, 2026
608fc38
cleanup
lukegalbraithrussell Aug 20, 2026
f8c6b89
fencing
lukegalbraithrussell Aug 20, 2026
9cdcc00
gen reference sidebar
lukegalbraithrussell Aug 25, 2026
6353313
go
lukegalbraithrussell Aug 26, 2026
eef36ac
Merge main: adopt Ruff + docstring formatting from #1566/#1567
lukegalbraithrussell Aug 28, 2026
4ff3e0f
Md reference griffe (#1569)
lukegalbraithrussell Sep 1, 2026
ff4a9f2
Merge branch 'main' into md-reference
lukegalbraithrussell Sep 3, 2026
fae307f
consolidate and tests
lukegalbraithrussell Sep 4, 2026
d910487
ci idea
lukegalbraithrussell Sep 4, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
griffe
  • Loading branch information
lukegalbraithrussell committed Aug 20, 2026
commit 490dbde1c53caa9656d60f79d03101cffe2eae98
116 changes: 0 additions & 116 deletions docs/english/reference/adapter/aiohttp/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,121 +3,6 @@ sidebar_label: aiohttp
title: slack_bolt.adapter.aiohttp
---

## AsyncBoltRequest Objects

```python
class AsyncBoltRequest()
```

#### raw\_body: `str`

#### body: `Dict[str, Any]`

The raw request body (only plain text is supported for "http" mode)

#### query: `Dict[str, Sequence[str]]`

The query string data in any data format.

#### headers: `Dict[str, Sequence[str]]`

The request headers.

#### content\_type: `Optional[str]`

#### context: `AsyncBoltContext`

The context in this request.

#### lazy\_only: `bool`

#### lazy\_function\_name: `Optional[str]`

#### mode: `str`

The mode used for this request. (either "http" or "socket_mode")

#### \_\_init\_\_

```python
def __init__(*,
body: Union[str, dict],
query: Optional[Union[str, Dict[str, str],
Dict[str, Sequence[str]]]] = None,
headers: Optional[Dict[str, Union[str, Sequence[str]]]] = None,
context: Optional[Dict[str, Any]] = None,
mode: str = "http")
```

Request to a Bolt app.

**Arguments**:

- `body` - The raw request body (only plain text is supported for "http" mode)
- `query` - The query string data in any data format.
- `headers` - The request headers.
- `context` - The context in this request.
- `mode` - The mode used for this request. (either "http" or "socket_mode")

#### to\_copyable

```python
def to_copyable() -> "AsyncBoltRequest"
```

## BoltResponse Objects

```python
class BoltResponse()
```

#### status: `int`

HTTP status code

#### body: `str`

The response body (dict and str are supported)

#### headers: `Dict[str, Sequence[str]]`

The response headers.

#### \_\_init\_\_

```python
def __init__(*,
status: int,
body: Union[str, dict] = "",
headers: Optional[Dict[str, Union[str, Sequence[str]]]] = None)
```

The response from a Bolt app.

**Arguments**:

- `status` - HTTP status code
- `body` - The response body (dict and str are supported)
- `headers` - The response headers.

#### first\_headers

```python
def first_headers() -> Dict[str, str]
```

#### first\_headers\_without\_set\_cookie

```python
def first_headers_without_set_cookie() -> Dict[str, str]
```

#### cookies

```python
def cookies() -> Sequence[SimpleCookie]
```

#### to\_bolt\_request

```python
Expand All @@ -129,4 +14,3 @@ async def to_bolt_request(request: web.Request) -> AsyncBoltRequest
```python
async def to_aiohttp_response(bolt_resp: BoltResponse) -> web.Response
```

Loading