Skip to content

Commit e52d13e

Browse files
danciaclaradanciaclara
committed
formatting fixes
1 parent 31117ab commit e52d13e

File tree

206 files changed

+3690
-3498
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

206 files changed

+3690
-3498
lines changed

‎docs/api-reference/assets/create-user-asset-upload.md‎

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ Original filename of the asset
3232

3333
MIME type of the file
3434

35-
* `image/jpeg` - JPEG
36-
* `image/png` - PNG
37-
* `image/webp` - WebP
38-
* `image/jpg` - JPG
39-
* `image/gif` - GIF
35+
- `image/jpeg` - JPEG
36+
- `image/png` - PNG
37+
- `image/webp` - WebP
38+
- `image/jpg` - JPG
39+
- `image/gif` - GIF
4040

4141
</ApiParam>
4242

@@ -50,8 +50,8 @@ File size in bytes
5050

5151
Type of user asset
5252

53-
* `USER_AVATAR` - User Avatar
54-
* `USER_COVER` - User Cover
53+
- `USER_AVATAR` - User Avatar
54+
- `USER_COVER` - User Cover
5555

5656
</ApiParam>
5757

@@ -66,7 +66,6 @@ Type of user asset
6666

6767
</div>
6868

69-
7069
</div>
7170

7271
<div class="api-right">
@@ -115,14 +114,14 @@ const response = await fetch("https://api.plane.so/api/v1/assets/user-assets/",
115114
method: "POST",
116115
headers: {
117116
"X-API-Key": "your-api-key",
118-
"Content-Type": "application/json"
117+
"Content-Type": "application/json",
119118
},
120119
body: JSON.stringify({
121-
"name": "Example Name",
122-
"type": "image/jpeg",
123-
"size": 1024000,
124-
"entity_type": "USER_AVATAR"
125-
}),
120+
name: "Example Name",
121+
type: "image/jpeg",
122+
size: 1024000,
123+
entity_type: "USER_AVATAR",
124+
}),
126125
});
127126
const data = await response.json();
128127
```
@@ -153,7 +152,6 @@ const data = await response.json();
153152

154153
</ResponsePanel>
155154

156-
157155
</div>
158156

159157
</div>

‎docs/api-reference/assets/create-workspace-asset-upload.md‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,6 @@ External source system (for integration tracking)
8484

8585
</div>
8686

87-
8887
</div>
8988

9089
<div class="api-right">
@@ -137,16 +136,16 @@ const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspac
137136
method: "POST",
138137
headers: {
139138
"X-API-Key": "your-api-key",
140-
"Content-Type": "application/json"
139+
"Content-Type": "application/json",
141140
},
142141
body: JSON.stringify({
143-
"name": "Example Name",
144-
"type": "image/jpeg",
145-
"size": 1024000,
146-
"project_id": "550e8400-e29b-41d4-a716-446655440000",
147-
"external_id": "550e8400-e29b-41d4-a716-446655440000",
148-
"external_source": "github"
149-
}),
142+
name: "Example Name",
143+
type: "image/jpeg",
144+
size: 1024000,
145+
project_id: "550e8400-e29b-41d4-a716-446655440000",
146+
external_id: "550e8400-e29b-41d4-a716-446655440000",
147+
external_source: "github",
148+
}),
150149
});
151150
const data = await response.json();
152151
```
@@ -177,7 +176,6 @@ const data = await response.json();
177176

178177
</ResponsePanel>
179178

180-
181179
</div>
182180

183181
</div>

‎docs/api-reference/assets/delete-user-asset.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ Asset ID
4242

4343
</div>
4444

45-
4645
</div>
4746

4847
<div class="api-right">
@@ -77,7 +76,7 @@ print(response.status_code)
7776
const response = await fetch("https://api.plane.so/api/v1/assets/user-assets/asset-uuid/", {
7877
method: "DELETE",
7978
headers: {
80-
"X-API-Key": "your-api-key"
79+
"X-API-Key": "your-api-key",
8180
},
8281
});
8382
console.log(response.status);
@@ -92,7 +91,6 @@ No response body.
9291

9392
</ResponsePanel>
9493

95-
9694
</div>
9795

9896
</div>

‎docs/api-reference/assets/get-workspace-asset.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ The workspace_slug represents the unique workspace identifier for a workspace in
4545

4646
</div>
4747

48-
4948
</div>
5049

5150
<div class="api-right">
@@ -80,7 +79,7 @@ print(response.json())
8079
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/assets/asset-uuid/", {
8180
method: "GET",
8281
headers: {
83-
"X-API-Key": "your-api-key"
82+
"X-API-Key": "your-api-key",
8483
},
8584
});
8685
const data = await response.json();
@@ -105,7 +104,6 @@ const data = await response.json();
105104

106105
</ResponsePanel>
107106

108-
109107
</div>
110108

111109
</div>

‎docs/api-reference/assets/overview.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ Assets let you upload and manage files used across user profiles and workspaces,
1717

1818
### Attributes
1919

20-
21-
2220
</div>
2321
<div class="api-right">
2422

‎docs/api-reference/assets/update-user-asset.md‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ Additional attributes to update for the asset
5454

5555
</div>
5656

57-
5857
</div>
5958

6059
<div class="api-right">
@@ -107,16 +106,16 @@ const response = await fetch("https://api.plane.so/api/v1/assets/user-assets/ass
107106
method: "PATCH",
108107
headers: {
109108
"X-API-Key": "your-api-key",
110-
"Content-Type": "application/json"
109+
"Content-Type": "application/json",
111110
},
112111
body: JSON.stringify({
113-
"attributes": {
114-
"name": "Example Name",
115-
"type": "image/jpeg",
116-
"size": 1024000
117-
},
118-
"entity_type": "USER_AVATAR"
119-
}),
112+
attributes: {
113+
name: "Example Name",
114+
type: "image/jpeg",
115+
size: 1024000,
116+
},
117+
entity_type: "USER_AVATAR",
118+
}),
120119
});
121120
console.log(response.status);
122121
```
@@ -130,7 +129,6 @@ No response body.
130129

131130
</ResponsePanel>
132131

133-
134132
</div>
135133

136134
</div>

‎docs/api-reference/assets/update-workspace-asset.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,6 @@ Whether the asset has been successfully uploaded
6060

6161
</div>
6262

63-
6463
</div>
6564

6665
<div class="api-right">
@@ -103,11 +102,11 @@ const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspac
103102
method: "PATCH",
104103
headers: {
105104
"X-API-Key": "your-api-key",
106-
"Content-Type": "application/json"
105+
"Content-Type": "application/json",
107106
},
108107
body: JSON.stringify({
109-
"is_uploaded": true
110-
}),
108+
is_uploaded: true,
109+
}),
111110
});
112111
console.log(response.status);
113112
```
@@ -121,7 +120,6 @@ No response body.
121120

122121
</ResponsePanel>
123122

124-
125123
</div>
126124

127125
</div>

‎docs/api-reference/customer/add-customer-property.md‎

Lines changed: 29 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -63,22 +63,22 @@ Sort order.
6363

6464
<ApiParam name="property_type" type="string" :required="true">
6565

66-
* `TEXT` - Text
67-
* `DATETIME` - Datetime
68-
* `DECIMAL` - Decimal
69-
* `BOOLEAN` - Boolean
70-
* `OPTION` - Option
71-
* `RELATION` - Relation
72-
* `URL` - URL
73-
* `EMAIL` - Email
74-
* `FILE` - File
66+
- `TEXT` - Text
67+
- `DATETIME` - Datetime
68+
- `DECIMAL` - Decimal
69+
- `BOOLEAN` - Boolean
70+
- `OPTION` - Option
71+
- `RELATION` - Relation
72+
- `URL` - URL
73+
- `EMAIL` - Email
74+
- `FILE` - File
7575

7676
</ApiParam>
7777

7878
<ApiParam name="relation_type" type="string" :required="false">
7979

80-
* `ISSUE` - Issue
81-
* `USER` - User
80+
- `ISSUE` - Issue
81+
- `USER` - User
8282

8383
</ApiParam>
8484

@@ -229,28 +229,26 @@ const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspac
229229
method: "POST",
230230
headers: {
231231
"X-API-Key": "your-api-key",
232-
"Content-Type": "application/json"
232+
"Content-Type": "application/json",
233233
},
234234
body: JSON.stringify({
235-
"display_name": "Example Name",
236-
"description": "Example description",
237-
"logo_props": "example-value",
238-
"sort_order": 1,
239-
"property_type": "TEXT",
240-
"relation_type": "ISSUE",
241-
"is_required": true,
242-
"default_value": [
243-
"Example Name"
244-
],
245-
"settings": "example-value",
246-
"is_active": true,
247-
"is_multi": true,
248-
"validation_rules": "example-value",
249-
"external_source": "github",
250-
"external_id": "550e8400-e29b-41d4-a716-446655440000",
251-
"created_by": "550e8400-e29b-41d4-a716-446655440000",
252-
"updated_by": "550e8400-e29b-41d4-a716-446655440000"
253-
}),
235+
display_name: "Example Name",
236+
description: "Example description",
237+
logo_props: "example-value",
238+
sort_order: 1,
239+
property_type: "TEXT",
240+
relation_type: "ISSUE",
241+
is_required: true,
242+
default_value: ["Example Name"],
243+
settings: "example-value",
244+
is_active: true,
245+
is_multi: true,
246+
validation_rules: "example-value",
247+
external_source: "github",
248+
external_id: "550e8400-e29b-41d4-a716-446655440000",
249+
created_by: "550e8400-e29b-41d4-a716-446655440000",
250+
updated_by: "550e8400-e29b-41d4-a716-446655440000",
251+
}),
254252
});
255253
const data = await response.json();
256254
```

‎docs/api-reference/customer/add-customer-request.md‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -138,17 +138,15 @@ const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspac
138138
method: "POST",
139139
headers: {
140140
"X-API-Key": "your-api-key",
141-
"Content-Type": "application/json"
141+
"Content-Type": "application/json",
142142
},
143143
body: JSON.stringify({
144-
"name": "Example Name",
145-
"description": "example-value",
146-
"description_html": "<p>Example content</p>",
147-
"link": "https://example.com/resource",
148-
"work_item_ids": [
149-
"550e8400-e29b-41d4-a716-446655440000"
150-
]
151-
}),
144+
name: "Example Name",
145+
description: "example-value",
146+
description_html: "<p>Example content</p>",
147+
link: "https://example.com/resource",
148+
work_item_ids: ["550e8400-e29b-41d4-a716-446655440000"],
149+
}),
152150
});
153151
const data = await response.json();
154152
```

‎docs/api-reference/customer/add-customer.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -216,26 +216,26 @@ const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspac
216216
method: "POST",
217217
headers: {
218218
"X-API-Key": "your-api-key",
219-
"Content-Type": "application/json"
219+
"Content-Type": "application/json",
220220
},
221221
body: JSON.stringify({
222-
"name": "Example Name",
223-
"description": "example-value",
224-
"description_html": "<p>Example content</p>",
225-
"description_stripped": "Example description",
226-
"email": "Example Name",
227-
"website_url": "https://example.com/resource",
228-
"logo_props": "example-value",
229-
"domain": "Example Name",
230-
"employees": 1,
231-
"stage": "Example Name",
232-
"contract_status": "Example Name",
233-
"revenue": "Example Name",
234-
"archived_at": "2024-01-01T00:00:00Z",
235-
"created_by": "550e8400-e29b-41d4-a716-446655440000",
236-
"updated_by": "550e8400-e29b-41d4-a716-446655440000",
237-
"logo_asset": "550e8400-e29b-41d4-a716-446655440000"
238-
}),
222+
name: "Example Name",
223+
description: "example-value",
224+
description_html: "<p>Example content</p>",
225+
description_stripped: "Example description",
226+
email: "Example Name",
227+
website_url: "https://example.com/resource",
228+
logo_props: "example-value",
229+
domain: "Example Name",
230+
employees: 1,
231+
stage: "Example Name",
232+
contract_status: "Example Name",
233+
revenue: "Example Name",
234+
archived_at: "2024-01-01T00:00:00Z",
235+
created_by: "550e8400-e29b-41d4-a716-446655440000",
236+
updated_by: "550e8400-e29b-41d4-a716-446655440000",
237+
logo_asset: "550e8400-e29b-41d4-a716-446655440000",
238+
}),
239239
});
240240
const data = await response.json();
241241
```

0 commit comments

Comments
 (0)