Skip to content

Commit

Permalink
pr feedback on capability names
Browse files Browse the repository at this point in the history
  • Loading branch information
andykellr committed Oct 17, 2023
1 parent ded6176 commit e9dd41f
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -2556,12 +2556,20 @@ as standard OpAMP capabilities in the future.
#### CustomCapabilities

The Agent and Server should both use this message to signal that they support specific
custom capabilities. It is supported on ServerToAgent and AgentToServer. When this message
is sent, the list of supported custom capabilities should be updated to match this list.
If this message is never sent, it is assumed that no custom message types are supported.

Capabilities are identified by a reverse FQDN with optional version information. For
example, "com.company.capability/v2" identifies version 2 of "capability" created by
custom capabilities. It is supported on ServerToAgent and AgentToServer. This message
should only be sent when the list of supported custom capabilities changes. When this
message is sent, the list of supported custom capabilities should be updated to match this
list. If this message is never sent, it is assumed that no custom capabilities are
supported.

Capabilities must be identified by a reverse FQDN with optional version information. This
avoids collisions between capabilities introduced by different organizations. The
capability name is composed of the reverse FQDN of the organization that created the
custom capability, a period, and a short name identifying the capability. The version is
optional and is separated from the capability name by a forward slash, begins with the
letter "v", and is followed by a number identifying the version.

For example, "com.company.capability/v2" identifies version 2 of "capability" created by
"company.com".

If a CustomMessage is received with a capability that is not supported, the message can be
Expand Down

0 comments on commit e9dd41f

Please sign in to comment.