Skip to content

Commit 30b79c4

Browse files
committed
API/Resources: Add docs for the device type resource
Change-type: minor
1 parent 89070e8 commit 30b79c4

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

config/dictionaries/resource.json

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -438,6 +438,52 @@
438438
}
439439
]
440440
},
441+
{
442+
"id": "device_type",
443+
"name": "Device type",
444+
"fields": [
445+
"id",
446+
"slug",
447+
"name",
448+
"is_private",
449+
"is_of__cpu_architecture",
450+
"belongs_to__device_family"
451+
],
452+
"examples": [
453+
{
454+
"id": "device-type-by-id",
455+
"summary": "Get a device type by its ID",
456+
"description": "When querying a private device type it's necessary to include your bearer token. For public device types the auth header is optional.",
457+
"method": "GET",
458+
"endpoint": "/v6/device_type(<ID>)",
459+
"filters": ""
460+
},
461+
{
462+
"id": "device-type-by-handle",
463+
"summary": "Get a device type by its SLUG",
464+
"description": "When querying a private device type it's necessary to include your bearer token. For public device types the auth header is optional.",
465+
"method": "GET",
466+
"endpoint": "/v6/device_type(slug='<DEVICE TYPE SLUG>')",
467+
"filters": ""
468+
},
469+
{
470+
"id": "device-type-by-name",
471+
"summary": "Get a device type by its NAME",
472+
"description": "When querying a private device type it's necessary to include your bearer token. For public device types the auth header is optional.",
473+
"method": "GET",
474+
"endpoint": "/v6/device_type",
475+
"filters": "?\\$filter=name%20eq%20'<DEVICE TYPE NAME>'"
476+
},
477+
{
478+
"id": "get-supported-device-types",
479+
"summary": "Get all supported device types",
480+
"description": "When querying a private device type it's necessary to include your bearer token. For public device types the auth header is optional.",
481+
"method": "GET",
482+
"endpoint": "/v6/device_type",
483+
"filters": "?\\$filter=is_default_for__application/any(idfa:(idfa/is_host%20eq%20true)%20and%20(idfa/is_archived%20eq%20false)%20and%20(idfa/owns__release/any(r:(r/status%20eq%20'success')%20and%20(r/is_final%20eq%20true)%20and%20(r/is_invalidated%20eq%20false))))&\\$orderby=name%20asc"
484+
}
485+
]
486+
},
441487
{
442488
"id": "device_config_variable",
443489
"name": "Device config variable",

0 commit comments

Comments
 (0)