Skip to content

Commit d640355

Browse files
authored
Remove ResponseExample from most docs pt.1 (#285)
1 parent 9ac26c7 commit d640355

Some content is hidden

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

61 files changed

+0
-1627
lines changed

docs/api-reference/data/activity/get-raw.mdx

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -93,24 +93,3 @@ fmt.Printf("Received data %s\n", response)
9393
```
9494

9595
</RequestExample>
96-
97-
<ResponseExample>
98-
99-
```json Response
100-
{
101-
"activity": [
102-
{
103-
"timestamp": "2022-08-04T12:42:44.847351+00:00",
104-
"data": {
105-
"data": "...provider_specific_data"
106-
},
107-
"provider_id": "e2b25f37-846e-49a9-bf5b-5bb24d62b289",
108-
"user_id": "8e837eec-0717-41df-b108-43f4f206582a",
109-
"source_id": 1,
110-
"priority_id": 1
111-
}
112-
]
113-
}
114-
```
115-
116-
</ResponseExample>

docs/api-reference/data/activity/get-summary.mdx

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -93,36 +93,3 @@ fmt.Printf("Received data %s\n", response)
9393
```
9494

9595
</RequestExample>
96-
97-
<ResponseExample>
98-
99-
```json Response
100-
{
101-
"activity": [
102-
{
103-
"calendar_date": "2022-08-04",
104-
"calories_total": 100,
105-
"calories_active": 2000,
106-
"steps": 10000,
107-
"daily_movement": 200,
108-
"low": 6400,
109-
"medium": 6400,
110-
"high": 6000,
111-
"source": {
112-
"name": "Garmin",
113-
"slug": "garmin",
114-
"logo": "https://logo_url.com"
115-
},
116-
"user_id": "70c64d5a-ff06-4c16-b137-361b2441d86e",
117-
"heart_rate": {
118-
"avg_bpm": 76.4,
119-
"max_bpm": 134,
120-
"min_bpm": 55,
121-
"resting_bpm": 60
122-
}
123-
}
124-
]
125-
}
126-
```
127-
128-
</ResponseExample>

docs/api-reference/data/body/get-raw.mdx

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -93,24 +93,3 @@ fmt.Printf("Received data %s\n", response)
9393
```
9494

9595
</RequestExample>
96-
97-
<ResponseExample>
98-
99-
```json Response
100-
{
101-
"body": [
102-
{
103-
"timestamp": "2022-08-04T12:42:44.849767+00:00",
104-
"data": {
105-
"data": "...provider_specific_data"
106-
},
107-
"provider_id": "ed059fb6-3bb4-4c4b-9aae-0fec51224e06",
108-
"user_id": "9d2b6976-3226-40cc-8adc-e8c2b898e0de",
109-
"source_id": 1,
110-
"priority_id": 1
111-
}
112-
]
113-
}
114-
```
115-
116-
</ResponseExample>

docs/api-reference/data/body/get-summary.mdx

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -93,27 +93,3 @@ fmt.Printf("Received data %s\n", response)
9393
```
9494

9595
</RequestExample>
96-
97-
<ResponseExample>
98-
99-
```json Response
100-
{
101-
"body": [
102-
{
103-
"id": "4340a0fa-549c-4a47-bd83-b2af6bbeffa9",
104-
"calendar_date": "2022-08-04",
105-
"weight": "80kg",
106-
"fat": "30%",
107-
"height": 183,
108-
"source": {
109-
"name": "Oura",
110-
"slug": "oura",
111-
"logo": "https://logo_url.com"
112-
},
113-
"user_id": "7a9ca5ad-2a2c-4a11-a9ee-e7a06c219594"
114-
}
115-
]
116-
}
117-
```
118-
119-
</ResponseExample>

docs/api-reference/data/meal/get-summary.mdx

Lines changed: 0 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -90,95 +90,3 @@ fmt.Printf("Received data %s\n", response)
9090
```
9191

9292
</RequestExample>
93-
94-
<ResponseExample>
95-
96-
```json Example
97-
{
98-
"meals": [
99-
{
100-
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
101-
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
102-
"priority_id": 42,
103-
"source_id": 10,
104-
"provider_id": "123456",
105-
"timestamp": "2019-08-24T14:15:22Z",
106-
"name": "Dinner",
107-
"data": {
108-
"Chiken coquet starter": {
109-
"energy": {
110-
"unit": "kcal",
111-
"value": 400
112-
},
113-
"macros": {
114-
"carbs": 75,
115-
"protein": 10,
116-
"fats": {
117-
"saturated": 98,
118-
"monounsaturated": 1,
119-
"polyunsaturated": 1,
120-
"omega3": 0,
121-
"omega6": 0,
122-
"total": 100
123-
},
124-
"sugar": 25
125-
},
126-
"micros": {
127-
"minerals": {
128-
"sodium": 500
129-
}
130-
}
131-
},
132-
"Coffee, black, 1 tbsp(s)": {
133-
"energy": {
134-
"unit": "kcal",
135-
"value": 0
136-
},
137-
"macros": {
138-
"carbs": 0,
139-
"protein": 0,
140-
"fats": {
141-
"total": 0
142-
},
143-
"sugar": 0
144-
},
145-
"micros": {
146-
"minerals": {
147-
"sodium": 0
148-
}
149-
}
150-
}
151-
},
152-
"source": {
153-
"name": "MyFitnessPal",
154-
"slug": "my_fitness_pal",
155-
"logo": "https://logo_url.com"
156-
},
157-
"created_at": "2019-08-24T14:15:22Z",
158-
"updated_at": "2019-08-24T14:15:22Z"
159-
}
160-
]
161-
}
162-
```
163-
164-
</ResponseExample>
165-
166-
<Info>
167-
All values in the returned model are supplied in the following units:
168-
</Info>
169-
170-
- `meals[*].data[*].energy.value` in calories `kcal`
171-
- `meals[*].data[*].macros.carbs` in grams `g`
172-
- `meals[*].data[*].macros.protein` in grams `g`
173-
- `meals[*].data[*].macros.fats.saturated` in grams `g`
174-
- `meals[*].data[*].macros.fats.monounsaturated` in grams `g`
175-
- `meals[*].data[*].macros.fats.polyunsaturated` in grams `g`
176-
- `meals[*].data[*].macros.fats.omega3` in grams `g`
177-
- `meals[*].data[*].macros.fats.omega6` in grams `g`
178-
- `meals[*].data[*].macros.alcohol` in litres `lt`
179-
- `meals[*].data[*].macros.water` in litres `lt`
180-
- `meals[*].data[*].macros.fibre` in grams `g`
181-
- `meals[*].data[*].macros.sugar` in grams `g`
182-
- `meals[*].data[*].micros.minerals` key: value pairs in milligrams `mg`
183-
- `meals[*].data[*].micros.trace_elements` key: value pairs in milligrams `mg`
184-
- `meals[*].data[*].micros.vitamins` key: value pairs in milligrams `mg`

docs/api-reference/data/profile/get-raw.mdx

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -70,22 +70,3 @@ fmt.Printf("Received data %s\n", response)
7070
```
7171

7272
</RequestExample>
73-
74-
<ResponseExample>
75-
76-
```json Example
77-
{
78-
"profile": [
79-
{
80-
"data": {
81-
"data": "...provider_specific_data"
82-
},
83-
"provider_id": "d0a7670c-dff8-4026-a188-8f249fb92e13",
84-
"user_id": "c0847403-4b5c-434d-ac32-8f347dcc6c33",
85-
"source_id": 1
86-
}
87-
]
88-
}
89-
```
90-
91-
</ResponseExample>

docs/api-reference/data/profile/get-summary.mdx

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -68,21 +68,3 @@ fmt.Printf("Received data %s\n", response)
6868
```
6969

7070
</RequestExample>
71-
72-
<ResponseExample>
73-
74-
```json Example
75-
{
76-
"id": "eadba0c7-4e81-4d17-962c-9ebe0629c08f",
77-
"date": "2022-08-04",
78-
"height": 183,
79-
"source": {
80-
"name": "Oura",
81-
"slug": "oura",
82-
"logo": "https://logo_url.com"
83-
},
84-
"user_id": "71937dd3-aebe-46b7-ab64-c287bd75b2a6"
85-
}
86-
```
87-
88-
</ResponseExample>

docs/api-reference/data/sleep/get-raw.mdx

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -91,24 +91,3 @@ fmt.Printf("Received data %s\n", response)
9191
```
9292

9393
</RequestExample>
94-
95-
<ResponseExample>
96-
97-
```json Response
98-
{
99-
"sleep": [
100-
{
101-
"timestamp": "2022-08-04T12:42:44.853437+00:00",
102-
"data": {
103-
"data": "...provider_specific_data"
104-
},
105-
"provider_id": "acddfb23-a2fd-417b-82ac-37c060074bef",
106-
"user_id": "8479b190-fff6-44cf-84f2-0e906457b343",
107-
"source_id": 1,
108-
"priority_id": 1
109-
}
110-
]
111-
}
112-
```
113-
114-
</ResponseExample>

0 commit comments

Comments
 (0)