tangled
alpha
login
or
join now
stream.place
/
streamplace
Live video on the AT Protocol
74
fork
atom
overview
issues
1
pulls
pipelines
docs: add oauth docs
Eli Mallon
9 months ago
ce8b3df2
a1bcb341
+19
-16
3 changed files
expand all
collapse all
unified
split
Makefile
js
docs
src
content
docs
lex-reference
account
place-stream-account-defs.md
place-stream-account-login.md
+2
-1
Makefile
···
118
118
md-lexicons:
119
119
yarn exec lexmd \
120
120
lexicons/place/stream \
121
121
-
js/docs/src/content/docs/lex-reference
121
121
+
js/docs/src/content/docs/lex-reference \
122
122
+
&& $(MAKE) fix
122
123
123
124
.PHONY: lexgen
124
125
lexgen:
+7
-6
js/docs/src/content/docs/lex-reference/account/place-stream-account-defs.md
···
2
2
title: place.stream.account.defs
3
3
description: Reference for the place.stream.account.defs lexicon
4
4
---
5
5
+
5
6
**Lexicon Version:** 1
6
7
7
8
## Definitions
8
9
9
10
<a name="loginresponse"></a>
11
11
+
10
12
### `loginResponse`
11
13
12
14
**Type:** `object`
13
15
14
16
**Properties:**
15
17
16
16
-
| Name | Type | Req'd | Description | Constraints |
17
17
-
|------|------|----------|-------------|-------------|
18
18
-
| `redirectUrl` | `string` | ✅ | | Format: `uri` |
18
18
+
| Name | Type | Req'd | Description | Constraints |
19
19
+
| ------------- | -------- | ----- | ----------- | ------------- |
20
20
+
| `redirectUrl` | `string` | ✅ | | Format: `uri` |
19
21
20
22
---
21
23
22
24
## Lexicon Source
25
25
+
23
26
```json
24
27
{
25
28
"lexicon": 1,
···
27
30
"defs": {
28
31
"loginResponse": {
29
32
"type": "object",
30
30
-
"required": [
31
31
-
"redirectUrl"
32
32
-
],
33
33
+
"required": ["redirectUrl"],
33
34
"properties": {
34
35
"redirectUrl": {
35
36
"type": "string",
+10
-9
js/docs/src/content/docs/lex-reference/account/place-stream-account-login.md
···
2
2
title: place.stream.account.login
3
3
description: Reference for the place.stream.account.login lexicon
4
4
---
5
5
+
5
6
**Lexicon Version:** 1
6
7
7
8
## Definitions
8
9
9
10
<a name="main"></a>
11
11
+
10
12
### `main`
11
13
12
14
**Type:** `procedure`
···
22
24
23
25
**Schema Type:** `object`
24
26
25
25
-
| Name | Type | Req'd | Description | Constraints |
26
26
-
|------|------|----------|-------------|-------------|
27
27
-
| `handleOrDID` | `string` | ✅ | The handle or DID of the account to login. | |
27
27
+
| Name | Type | Req'd | Description | Constraints |
28
28
+
| ------------- | -------- | ----- | ------------------------------------------ | ----------- |
29
29
+
| `handleOrDID` | `string` | ✅ | The handle or DID of the account to login. | |
30
30
+
28
31
**Output:**
29
32
30
33
- **Encoding:** `application/json`
31
34
- **Schema:**
32
35
33
33
-
**Schema Type:** [`place.stream.account.defs#loginResponse`](/lex-reference/place-stream-account-defs#loginresponse)
34
34
-
35
35
-
36
36
+
**Schema Type:**
37
37
+
[`place.stream.account.defs#loginResponse`](/lex-reference/place-stream-account-defs#loginresponse)
36
38
37
39
---
38
40
39
41
## Lexicon Source
42
42
+
40
43
```json
41
44
{
42
45
"lexicon": 1,
···
49
52
"encoding": "application/json",
50
53
"schema": {
51
54
"type": "object",
52
52
-
"required": [
53
53
-
"handleOrDID"
54
54
-
],
55
55
+
"required": ["handleOrDID"],
55
56
"properties": {
56
57
"handleOrDID": {
57
58
"type": "string",