Skip to content

Commit

Permalink
X-Moera: name= parameter.
Browse files Browse the repository at this point in the history
  • Loading branch information
smelamud committed Mar 12, 2024
1 parent b4925c3 commit 2c2314a
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion development/node-api/headers.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Architecture Overview section.
## Clients

<h4 class="identifier">
X-Moera: [root={root}] [page={page}]
X-Moera: [root={root}] [page={page}] [name={name}]
</h4>

This header is sent by a website in HTTP response. It signals that the
Expand All @@ -26,6 +26,12 @@ the website root by default). Virtual pages are located under `/moera`
subdirectory of the Moera root, the REST API endpoint is located at
`/moera/api`.

If `name` is set, it defines the name of the node. Knowing the node name earlier
allows the client to start using REST API without making `/whoami` request
first. However, the client should not trust the node that the name belongs to
it. The client should verify the name through a naming server as soon as
possible.

<h4 class="identifier">
X-Accept-Moera: {version}
</h4>
Expand Down

0 comments on commit 2c2314a

Please sign in to comment.