Skip to content
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

DOCS-3719: Discourage creation of new APIs #4098

Merged
merged 1 commit into from
Mar 19, 2025
Merged

DOCS-3719: Discourage creation of new APIs #4098

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion docs/operate/reference/advanced-modules/create-subtype.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Define a New Resource API"
title: "Define a new resource API"
linkTitle: "Custom API"
weight: 30
type: "docs"
Expand All @@ -21,6 +21,9 @@ You can define a new, custom {{< glossary_tooltip term_id="resource" text="resou

{{% alert title="Tip" color="tip" %}}

Defining a new resource API is significantly more complex than using an existing API.
In most cases, you should try to use an existing API rather than define a new one.

If you want to use most of an existing API but need just a few other functions, try using the `DoCommand` endpoint and [extra parameters](/dev/reference/sdks/use-extra-params/) to add custom functionality to an existing API.
For example, if you have a [sensor](/operate/reference/components/sensor/) and you want to define a `Calibrate` method, you can use `DoCommand`.

Expand Down
Loading