Skip to content

Commit 61a2937

Browse files
authored
DOCS-3672: Add config api, namespace, type changes to changelog (#4133)
1 parent fdaf622 commit 61a2937

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/dev/reference/changelog.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,34 @@ The [hot data store](/manage/reference/processes/) allows you to access recent d
4747

4848
{{% /changelog %}}
4949

50+
{{% changelog color="changed" title="Config uses API instead of type and namespace" date="2025-03-25" %}}
51+
52+
The JSON configuration for a resource now uses a field called `api` for the {{< glossary_tooltip term_id="api-namespace-triplet" text="API triplet" >}} instead of the deprecated `type` and `namespace` fields.
53+
For example, instead of:
54+
55+
```json
56+
{
57+
"name": "my_board",
58+
"namespace": "rdk",
59+
"type": "board",
60+
"model": "viam:nvidia:jetson"
61+
}
62+
```
63+
64+
You should use:
65+
66+
```json
67+
{
68+
"name": "my_board",
69+
"api": "rdk:component:board",
70+
"model": "viam:nvidia:jetson"
71+
}
72+
```
73+
74+
Backward compatibility is maintained for existing configurations.
75+
76+
{{% /changelog %}}
77+
5078
{{% changelog color="removed" title="Managed Processes" date="2025-02-01" %}}
5179

5280
[Managed Processes](/manage/reference/processes/) are now deprecated and will be removed in a future version of `viam-server`.

0 commit comments

Comments
 (0)