Skip to content

Commit

Permalink
More reminders. API for storing mnemonic on the node.
Browse files Browse the repository at this point in the history
  • Loading branch information
smelamud committed Sep 19, 2024
1 parent dd50848 commit 50e5cff
Show file tree
Hide file tree
Showing 3 changed files with 133 additions and 0 deletions.
43 changes: 43 additions & 0 deletions _data/node_api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1675,6 +1675,33 @@ objects:
errors:
- code: naming.operation-pending
description: another operation with the node name is pending currently
- url: /node-name/mnemonic
type: GET
function: getStoredMnemonic
out:
struct: KeyMnemonic
auth: admin
description: Get the updating key mnemonic stored on the node.
errors:
- code: not-found
description: the mnemonic is not stored
- url: /node-name/mnemonic
type: POST
function: storeMnemonic
in:
struct: KeyMnemonic
name: mnemonic
out:
struct: Result
auth: admin
description: Store the updating key mnemonic on the node.
- url: /node-name/mnemonic
type: DELETE
function: deleteStoredMnemonic
out:
struct: Result
auth: admin
description: Delete the updating key mnemonic stored on the node.
- name: Notifications
description: Receiver of notifications from other nodes.
requests:
Expand Down Expand Up @@ -4983,6 +5010,11 @@ structures:
array: true
name: scope
description: the set of administrative permissions granted to the node
- name: KeyMnemonic
fields:
- type: String[]
name: mnemonic
description: the words
- name: LinkPreview
fields:
- type: String
Expand Down Expand Up @@ -5140,6 +5172,11 @@ structures:
name: operationErrorMessage
optional: true
description: if the operation with the node name was failed, the human-readable description of the failure
- type: boolean
name: storedMnemonic
optional: true
description: >
<code>true</code>, if updating key mnemonic is being stored on the node, <code>false</code> otherwise
- struct: NodeNameOperations
name: operations
optional: true
Expand Down Expand Up @@ -8253,8 +8290,14 @@ enums:
description: a negative reaction was added to the user's posting
- name: reaction-added-positive
description: a positive reaction was added to the user's posting
- name: reminder-avatar
description: reminder for the user to set an avatar
- name: reminder-email
description: reminder for the user to set an email
- name: reminder-full-name
description: reminder for the user to set a full name
- name: reminder-sheriff-allow
description: reminder for the user to allow access for Google Play sheriff
- name: remote-comment-added
description: a comment was added under a posting the user is subscribed to
- name: reply-comment
Expand Down
45 changes: 45 additions & 0 deletions _data/py_node_api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,10 @@ enums:
- description: all permissions
name: all
value: '0x3fffffff'
- name: SearchEngine
values:
- description: Google
name: google
- name: SettingType
values:
- description: boolean, may have value <code>true</code> or <code>false</code>
Expand Down Expand Up @@ -348,8 +352,14 @@ enums:
name: reaction-added-negative
- description: a positive reaction was added to the user's posting
name: reaction-added-positive
- description: reminder for the user to set an avatar
name: reminder-avatar
- description: reminder for the user to set an email
name: reminder-email
- description: reminder for the user to set a full name
name: reminder-full-name
- description: reminder for the user to allow access for Google Play sheriff
name: reminder-sheriff-allow
- description: a comment was added under a posting the user is subscribed to
name: remote-comment-added
- description: a reply was added to the user's comment
Expand Down Expand Up @@ -2140,6 +2150,29 @@ objects:
out:
struct: Result
params: []
- auth: admin
description: Get the updating key mnemonic stored on the node.
errors:
- code: not-found
description: the mnemonic is not stored
function: get_stored_mnemonic()
out:
struct: KeyMnemonic
params: []
- auth: admin
description: Store the updating key mnemonic on the node.
function: store_mnemonic(mnemonic)
out:
struct: Result
params:
- name: mnemonic
struct: KeyMnemonic
- auth: admin
description: Delete the updating key mnemonic stored on the node.
function: delete_stored_mnemonic()
out:
struct: Result
params: []
- description: Receiver of notifications from other nodes.
name: Notifications
requests:
Expand Down Expand Up @@ -5555,6 +5588,11 @@ structures:
enum: Scope
name: scope
name: GrantInfo
- fields:
- description: the words
name: mnemonic
type: List[str]
name: KeyMnemonic
- fields:
- description: name of the site
name: site_name
Expand Down Expand Up @@ -5721,6 +5759,13 @@ structures:
name: operation_error_message
optional: true
type: str
- description: '<code>True</code>, if updating key mnemonic is being stored on the
node, <code>False</code> otherwise
'
name: stored_mnemonic
optional: true
type: bool
- description: the supported operations and the corresponding principals
name: operations
optional: true
Expand Down
45 changes: 45 additions & 0 deletions _data/ts_node_api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,10 @@ enums:
- description: all permissions
name: all
value: '0x3fffffff'
- name: SearchEngine
values:
- description: Google
name: google
- name: SettingType
values:
- description: boolean, may have value <code>true</code> or <code>false</code>
Expand Down Expand Up @@ -348,8 +352,14 @@ enums:
name: reaction-added-negative
- description: a positive reaction was added to the user's posting
name: reaction-added-positive
- description: reminder for the user to set an avatar
name: reminder-avatar
- description: reminder for the user to set an email
name: reminder-email
- description: reminder for the user to set a full name
name: reminder-full-name
- description: reminder for the user to allow access for Google Play sheriff
name: reminder-sheriff-allow
- description: a comment was added under a posting the user is subscribed to
name: remote-comment-added
- description: a reply was added to the user's comment
Expand Down Expand Up @@ -2139,6 +2149,29 @@ objects:
out:
struct: Result
params: []
- auth: admin
description: Get the updating key mnemonic stored on the node.
errors:
- code: not-found
description: the mnemonic is not stored
function: getStoredMnemonic()
out:
struct: KeyMnemonic
params: []
- auth: admin
description: Store the updating key mnemonic on the node.
function: storeMnemonic(mnemonic)
out:
struct: Result
params:
- name: mnemonic
struct: KeyMnemonic
- auth: admin
description: Delete the updating key mnemonic stored on the node.
function: deleteStoredMnemonic()
out:
struct: Result
params: []
- description: Receiver of notifications from other nodes.
name: Notifications
requests:
Expand Down Expand Up @@ -5552,6 +5585,11 @@ structures:
enum: Scope
name: scope
name: GrantInfo
- fields:
- description: the words
name: mnemonic
type: string[]
name: KeyMnemonic
- fields:
- description: name of the site
name: siteName
Expand Down Expand Up @@ -5718,6 +5756,13 @@ structures:
name: operationErrorMessage
optional: true
type: string
- description: '<code>true</code>, if updating key mnemonic is being stored on the
node, <code>false</code> otherwise
'
name: storedMnemonic
optional: true
type: boolean
- description: the supported operations and the corresponding principals
name: operations
optional: true
Expand Down

0 comments on commit 50e5cff

Please sign in to comment.