Skip to content

Remove ResponseExample from most docs pt.2 - Lab Testing #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
andersio wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Remove ResponseExample from most docs pt.2 - Lab Testing #286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b30e8c
Remove ResponseExample from most docs pt.1
andersio Nov 7, 2024
49499d3
Remove ResponseExample from most docs pt.2 - Lab Testing
andersio Nov 7, 2024
8cc1400
Documentation edits made through Mintlify web editor
mintlify[bot] Aug 5, 2025
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
21 changes: 0 additions & 21 deletions docs/api-reference/data/activity/get-raw.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,24 +93,3 @@ fmt.Printf("Received data %s\n", response)
```

</RequestExample>

<ResponseExample>

```json Response
{
"activity": [
{
"timestamp": "2022-08-04T12:42:44.847351+00:00",
"data": {
"data": "...provider_specific_data"
},
"provider_id": "e2b25f37-846e-49a9-bf5b-5bb24d62b289",
"user_id": "8e837eec-0717-41df-b108-43f4f206582a",
"source_id": 1,
"priority_id": 1
}
]
}
```

</ResponseExample>
33 changes: 0 additions & 33 deletions docs/api-reference/data/activity/get-summary.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,36 +93,3 @@ fmt.Printf("Received data %s\n", response)
```

</RequestExample>

<ResponseExample>

```json Response
{
"activity": [
{
"calendar_date": "2022-08-04",
"calories_total": 100,
"calories_active": 2000,
"steps": 10000,
"daily_movement": 200,
"low": 6400,
"medium": 6400,
"high": 6000,
"source": {
"name": "Garmin",
"slug": "garmin",
"logo": "https://logo_url.com"
},
"user_id": "70c64d5a-ff06-4c16-b137-361b2441d86e",
"heart_rate": {
"avg_bpm": 76.4,
"max_bpm": 134,
"min_bpm": 55,
"resting_bpm": 60
}
}
]
}
```

</ResponseExample>
21 changes: 0 additions & 21 deletions docs/api-reference/data/body/get-raw.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,24 +93,3 @@ fmt.Printf("Received data %s\n", response)
```

</RequestExample>

<ResponseExample>

```json Response
{
"body": [
{
"timestamp": "2022-08-04T12:42:44.849767+00:00",
"data": {
"data": "...provider_specific_data"
},
"provider_id": "ed059fb6-3bb4-4c4b-9aae-0fec51224e06",
"user_id": "9d2b6976-3226-40cc-8adc-e8c2b898e0de",
"source_id": 1,
"priority_id": 1
}
]
}
```

</ResponseExample>
24 changes: 0 additions & 24 deletions docs/api-reference/data/body/get-summary.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,27 +93,3 @@ fmt.Printf("Received data %s\n", response)
```

</RequestExample>

<ResponseExample>

```json Response
{
"body": [
{
"id": "4340a0fa-549c-4a47-bd83-b2af6bbeffa9",
"calendar_date": "2022-08-04",
"weight": "80kg",
"fat": "30%",
"height": 183,
"source": {
"name": "Oura",
"slug": "oura",
"logo": "https://logo_url.com"
},
"user_id": "7a9ca5ad-2a2c-4a11-a9ee-e7a06c219594"
}
]
}
```

</ResponseExample>
92 changes: 0 additions & 92 deletions docs/api-reference/data/meal/get-summary.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,95 +90,3 @@ fmt.Printf("Received data %s\n", response)
```

</RequestExample>

<ResponseExample>

```json Example
{
"meals": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"priority_id": 42,
"source_id": 10,
"provider_id": "123456",
"timestamp": "2019-08-24T14:15:22Z",
"name": "Dinner",
"data": {
"Chiken coquet starter": {
"energy": {
"unit": "kcal",
"value": 400
},
"macros": {
"carbs": 75,
"protein": 10,
"fats": {
"saturated": 98,
"monounsaturated": 1,
"polyunsaturated": 1,
"omega3": 0,
"omega6": 0,
"total": 100
},
"sugar": 25
},
"micros": {
"minerals": {
"sodium": 500
}
}
},
"Coffee, black, 1 tbsp(s)": {
"energy": {
"unit": "kcal",
"value": 0
},
"macros": {
"carbs": 0,
"protein": 0,
"fats": {
"total": 0
},
"sugar": 0
},
"micros": {
"minerals": {
"sodium": 0
}
}
}
},
"source": {
"name": "MyFitnessPal",
"slug": "my_fitness_pal",
"logo": "https://logo_url.com"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
```

</ResponseExample>

<Info>
All values in the returned model are supplied in the following units:
</Info>

- `meals[*].data[*].energy.value` in calories `kcal`
- `meals[*].data[*].macros.carbs` in grams `g`
- `meals[*].data[*].macros.protein` in grams `g`
- `meals[*].data[*].macros.fats.saturated` in grams `g`
- `meals[*].data[*].macros.fats.monounsaturated` in grams `g`
- `meals[*].data[*].macros.fats.polyunsaturated` in grams `g`
- `meals[*].data[*].macros.fats.omega3` in grams `g`
- `meals[*].data[*].macros.fats.omega6` in grams `g`
- `meals[*].data[*].macros.alcohol` in litres `lt`
- `meals[*].data[*].macros.water` in litres `lt`
- `meals[*].data[*].macros.fibre` in grams `g`
- `meals[*].data[*].macros.sugar` in grams `g`
- `meals[*].data[*].micros.minerals` key: value pairs in milligrams `mg`
- `meals[*].data[*].micros.trace_elements` key: value pairs in milligrams `mg`
- `meals[*].data[*].micros.vitamins` key: value pairs in milligrams `mg`
19 changes: 0 additions & 19 deletions docs/api-reference/data/profile/get-raw.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,22 +70,3 @@ fmt.Printf("Received data %s\n", response)
```

</RequestExample>

<ResponseExample>

```json Example
{
"profile": [
{
"data": {
"data": "...provider_specific_data"
},
"provider_id": "d0a7670c-dff8-4026-a188-8f249fb92e13",
"user_id": "c0847403-4b5c-434d-ac32-8f347dcc6c33",
"source_id": 1
}
]
}
```

</ResponseExample>
18 changes: 0 additions & 18 deletions docs/api-reference/data/profile/get-summary.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,21 +68,3 @@ fmt.Printf("Received data %s\n", response)
```

</RequestExample>

<ResponseExample>

```json Example
{
"id": "eadba0c7-4e81-4d17-962c-9ebe0629c08f",
"date": "2022-08-04",
"height": 183,
"source": {
"name": "Oura",
"slug": "oura",
"logo": "https://logo_url.com"
},
"user_id": "71937dd3-aebe-46b7-ab64-c287bd75b2a6"
}
```

</ResponseExample>
21 changes: 0 additions & 21 deletions docs/api-reference/data/sleep/get-raw.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,24 +91,3 @@ fmt.Printf("Received data %s\n", response)
```

</RequestExample>

<ResponseExample>

```json Response
{
"sleep": [
{
"timestamp": "2022-08-04T12:42:44.853437+00:00",
"data": {
"data": "...provider_specific_data"
},
"provider_id": "acddfb23-a2fd-417b-82ac-37c060074bef",
"user_id": "8479b190-fff6-44cf-84f2-0e906457b343",
"source_id": 1,
"priority_id": 1
}
]
}
```

</ResponseExample>
Loading
Loading