-
Notifications
You must be signed in to change notification settings - Fork 52
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b361d25
commit 8ddd830
Showing
14 changed files
with
107 additions
and
65 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,63 +1,105 @@ | ||
| --- | ||
| id: get-node-details | ||
| title: "Node Details" | ||
| description: "Returns information about the node including its DID, public key and build details" | ||
| sidebar_label: "Node Details" | ||
| title: 'Node Details' | ||
| description: 'Returns information about the node including its DID, public key and build details' | ||
| sidebar_label: 'Node details' | ||
| hide_title: true | ||
| hide_table_of_contents: true | ||
| api: eJy1Vm1v2zYQ/iuEviwBYluS32R9S+es8DoERetuwNx8oMSTxUQiVZJq7Br+77uT7ChO2noYMCCIaR5599zd8xy98wTY1MjKSa282PsArjbKMqkybUpOu4wnunbM5cCUFoCmtKiFVGsmnWXzxfyKVXVSyJQ9wJZxJVhSy0IwAY7LwnpXnq7ANK4WAkOswd2in/mT2fG19eKVR7ve3ZVnwFZaWcDNnRf6Pn2cojzcfYEMXaVaOVCObvCqQkxN2MG9pWs7z6Y5lJxWblsBOtLJPaTOo5hfamlAEA7ruHG4vPKaRPBTSPrfZvkOtriuTUFQK0O5OdliPV7s/FtnsFB4vq0m7gjuoOdkSWhPk1riJnooK/aYg+rq/cgt6yDBBk8U5Dv0w1EvCHvBZOnP4mEU+6O+Pxv/7e2PwM/keUCR6rKUZPsKxhKUV3k1B/9bUm8aKrhjat9NIBwtw2E8nuFfA/4A6DsBT32/lY61Z1nObc60YVJg92UmwZxESv2RHwCEE0hhmE2D8TgT0yiKRlHCsyAMUyGmfohV2XdVOBue6PoLcrCS7HjneUy/j+3w9vt9S5+z7uaITTnDC/kNBFs8JcIuUGKXTGfPed6FQd+xkkXssMAKHK0LdBhArQzU3wq3WRebWbYZzYZFaCLIJkYUhtcjYYVKKeGO1mcxvu90/iM8fiiCLJhFIpvxySjLeDhNw9kwmgQJTyFKIz8RkySAYOyD70fhZJpNs9kIOMxgkg4jv8FE8voZ4WojX4H79OEPUo6BTjopVywBZoCj8E/VkztX2XgwwHqJpCeg1P1D6fpYxkdtHjxqnZOuOX5Nk6YZUPt909MSXK4P44xmA3c5fhk0Ewm/WzBECpTZrk3mXwW8o4spJue2H2lUtfK7f3wuBvJDARo7fk+Am4bu7eK3Y4l+/2v5qkTXNK57aGG1pQFOhbr5GI4n7xgv1hrj5iXDIjNeowkJiPMTyQhKVFoqZ/ufFV2u+LbQXLCytu7wHED8WfWY5C5mC2trvMRdJ3uywaaK2c2mku1T0BnZhQGSMUYBcUlHeS1ituQGS9v2UTxpw6Jn+UIbTWRrY/ZrIdGCmjx3vmktPXHtdGtbjN2Yv2HX7xfPRuFRxi8L+ae0OHVWQqf2qYuYw93FscsvLZfNw7haY4XrhDYGt63xtu19S4vu/pmDl8xpVmDDFSu1gT6lhCTU1pW8GV2KN+QgxrLupT1JYte9lv/Ps38grIONG1QFl+qZslu9rLxWL8j7HLHTxm6XcAufTLHf0/aXGgwOphUuv3IjeUKtWt2hoxy4QN6TwB5odnnXaQpV847xoqbAr34BkL6edPv2Zok0+AeZiRCM | ||
| sidebar_class_name: "get api-method" | ||
| sidebar_class_name: 'get api-method' | ||
| info_path: api/nildb/nildb-api | ||
| custom_edit_url: null | ||
| --- | ||
|
|
||
| import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; | ||
| import ParamsDetails from "@theme/ParamsDetails"; | ||
| import RequestSchema from "@theme/RequestSchema"; | ||
| import StatusCodes from "@theme/StatusCodes"; | ||
| import OperationTabs from "@theme/OperationTabs"; | ||
| import TabItem from "@theme/TabItem"; | ||
| import Heading from "@theme/Heading"; | ||
| import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; | ||
| import ParamsDetails from '@theme/ParamsDetails'; | ||
| import RequestSchema from '@theme/RequestSchema'; | ||
| import StatusCodes from '@theme/StatusCodes'; | ||
| import OperationTabs from '@theme/OperationTabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
| import Heading from '@theme/Heading'; | ||
|
|
||
| <Heading | ||
| as={"h1"} | ||
| className={"openapi__heading"} | ||
| children={"Node Details"} | ||
| > | ||
| </Heading> | ||
| as={'h1'} | ||
| className={'openapi__heading'} | ||
| children={'Node Details'} | ||
| ></Heading> | ||
|
|
||
| <MethodEndpoint | ||
| method={"get"} | ||
| path={"/about"} | ||
| context={"endpoint"} | ||
| > | ||
|
|
||
| </MethodEndpoint> | ||
|
|
||
|
|
||
| method={'get'} | ||
| path={'/about'} | ||
| context={'endpoint'} | ||
| ></MethodEndpoint> | ||
|
|
||
| Returns information about the node including its DID, public key and build details | ||
|
|
||
| <ParamsDetails | ||
| parameters={undefined} | ||
| > | ||
|
|
||
| </ParamsDetails> | ||
| <ParamsDetails parameters={undefined}></ParamsDetails> | ||
|
|
||
| <RequestSchema | ||
| title={"Body"} | ||
| body={undefined} | ||
| > | ||
|
|
||
| </RequestSchema> | ||
| <RequestSchema title={'Body'} body={undefined}></RequestSchema> | ||
|
|
||
| <StatusCodes | ||
| id={undefined} | ||
| label={undefined} | ||
| responses={{"200":{"description":"Details about the node","content":{"application/json":{"schema":{"type":"object","required":["started","build","did","publicKey","url"],"properties":{"started":{"type":"string","format":"date-time","description":"Timestamp when the node was started","example":"2024-12-16T09:38:04.095Z"},"build":{"type":"object","required":["time","commit","version"],"properties":{"time":{"type":"string","format":"date-time","description":"Build timestamp","example":"2024-12-24T23:59:59Z"},"commit":{"type":"string","description":"Git commit hash or identifier","example":"c0401ee26ece3f7155fd788848baf122cdd702ed"},"version":{"type":"string","description":"Node's api version","example":"0.4.0"}}},"did":{"type":"string","description":"Decentralized Identifier (DID) of the node","example":"did:nil:testnet:nillion1eunreuzltxglx9fx493l2r8ef6rdlrau4dsdnc"},"publicKey":{"type":"string","description":"Public key of the node","example":"02d1f198df9a64ffa27c293861bace8c80bd6b1e150e008267f7f94eae9e6c380c"},"url":{"type":"string","format":"uri","description":"URL where the node can be reached","example":"https://nildb-demo.nillion.network"}},"title":"AboutNode"}}}}}} | ||
| > | ||
|
|
||
| </StatusCodes> | ||
|
|
||
|
|
||
|
|
||
| responses={{ | ||
| '200': { | ||
| description: 'Details about the node', | ||
| content: { | ||
| 'application/json': { | ||
| schema: { | ||
| type: 'object', | ||
| required: ['started', 'build', 'did', 'publicKey', 'url'], | ||
| properties: { | ||
| started: { | ||
| type: 'string', | ||
| format: 'date-time', | ||
| description: 'Timestamp when the node was started', | ||
| example: '2024-12-16T09:38:04.095Z', | ||
| }, | ||
| build: { | ||
| type: 'object', | ||
| required: ['time', 'commit', 'version'], | ||
| properties: { | ||
| time: { | ||
| type: 'string', | ||
| format: 'date-time', | ||
| description: 'Build timestamp', | ||
| example: '2024-12-24T23:59:59Z', | ||
| }, | ||
| commit: { | ||
| type: 'string', | ||
| description: 'Git commit hash or identifier', | ||
| example: 'c0401ee26ece3f7155fd788848baf122cdd702ed', | ||
| }, | ||
| version: { | ||
| type: 'string', | ||
| description: "Node's api version", | ||
| example: '0.4.0', | ||
| }, | ||
| }, | ||
| }, | ||
| did: { | ||
| type: 'string', | ||
| description: 'Decentralized Identifier (DID) of the node', | ||
| example: | ||
| 'did:nil:testnet:nillion1eunreuzltxglx9fx493l2r8ef6rdlrau4dsdnc', | ||
| }, | ||
| publicKey: { | ||
| type: 'string', | ||
| description: 'Public key of the node', | ||
| example: | ||
| '02d1f198df9a64ffa27c293861bace8c80bd6b1e150e008267f7f94eae9e6c380c', | ||
| }, | ||
| url: { | ||
| type: 'string', | ||
| format: 'uri', | ||
| description: 'URL where the node can be reached', | ||
| example: 'https://nildb-demo.nillion.network', | ||
| }, | ||
| }, | ||
| title: 'AboutNode', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }} | ||
| ></StatusCodes> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.