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