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.

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

sidekicks/_learn.new_id: make it possible to tell which existing sidekick has been learned #83

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
13 changes: 12 additions & 1 deletion sidekicks/schemas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -174,4 +174,15 @@ Learn:
description: |
Number of times a new Sidekick has been learned on this boot.
Useful in UI design to know that the learn process completed,
even if the learned address is the same.
even if the learned address is the same. Clients should check
`new_id` to determine which ID has been learned. This is required
in the case where the newly learned Sidekick is already
added to this Bond.
new_id:
example: SHAXX12345
type: string
readOnly: true
description: |
ID of the most recently learned Sidekick,
or `null` if no Sidekicks have been learned this boot.
This field is updated exactly when `learn_count` is incremented.