Skip to content
Snippets Groups Projects
Commit 70380d0b authored by Benoit Lavenier's avatar Benoit Lavenier
Browse files

[enh] Add documentation on index user/event

[fix] Remove documentation on GChange market/registry
parent 8504cf7a
No related branches found
No related tags found
No related merge requests found
...@@ -8,8 +8,12 @@ ...@@ -8,8 +8,12 @@
* [ES CORE API](#es-core-api) * [ES CORE API](#es-core-api)
* [currency](#currency) * [currency](#currency)
* [currency/block](#currencyblock) * [currency/block](#currencyblock)
* [currency/blockstat](#currencyblockstat)
* [currency/peer](#currencypeer)
* [currency/tx](#currencytx)
* [ES USER API](#userapi) * [ES USER API](#userapi)
* [user](#user) * [user](#user)
* [user/event](#userevent)
* [user/profile](#userprofile) * [user/profile](#userprofile)
* [user/settings](#usersettings) * [user/settings](#usersettings)
* [message](#message) * [message](#message)
...@@ -17,15 +21,6 @@ ...@@ -17,15 +21,6 @@
* [message/oubox](#messageoutbox) * [message/oubox](#messageoutbox)
* [invitation](#invitation) * [invitation](#invitation)
* [invitation/certification](#invitationcertification) * [invitation/certification](#invitationcertification)
* [ES GCHANGE API](#gchangeapi)
* [market](#market)
* [market/category](#marketcategory)
* [market/record](#marketrecord)
* [market/comment](#marletcomment)
* [registry](#registry)
* [registrymarket/category](#registrycategory)
* [registry/record](#registryrecord)
* [registry/comment](#registrycomment)
## Overview ## Overview
...@@ -33,30 +28,23 @@ Duniter4j Elasticsearch offer HTTP access to 3 main API : ...@@ -33,30 +28,23 @@ Duniter4j Elasticsearch offer HTTP access to 3 main API :
- `ES CORE API` (ECA): BlockChain indexation; - `ES CORE API` (ECA): BlockChain indexation;
- `ES USER API` (EUA): User data indexation, such as: profiles, private messages, settings (crypted); - `ES USER API` (EUA): User data indexation, such as: profiles, private messages, settings (crypted);
- `ES GCHANGE API` (EGA): Exchange data (market place: offer, ad...), professionals registry.
Data is made accessible through an HTTP API : Data is made accessible through an HTTP API :
http[s]://node[:port]/... http[s]://node[:port]/...
|-- <currency_name>/ |-- <currency_name>/
| `-- lookup | |-- block
| |-- blockstat
| |-- peer
| `-- tx
|-- user/ |-- user/
| |-- profile | |-- profile
| `-- settings | `-- settings
|-- message/ |-- message/
| |-- inbox | |-- inbox
| `-- outbox | `-- outbox
|-- invitation/ `-- invitation/
| `-- certification `-- certification
|-- market/
| |-- category
| |-- record
| `-- comment
`-- registry/
|-- category
|-- record
`-- comment
### Document format ### Document format
...@@ -97,10 +85,20 @@ For example, a deletion on `message/inbox` should send this document: ...@@ -97,10 +85,20 @@ For example, a deletion on `message/inbox` should send this document:
- Get a block by number: `<currency>/block/<number>` - Get a block by number: `<currency>/block/<number>`
- Search on blocks: `<currency>/block/_search` (POST or GET) - Search on blocks: `<currency>/block/_search` (POST or GET)
#### `<currency>/blockstat`
#### `<currency>/peer`
## ES USER API ## ES USER API
### `user/*` ### `user/*`
#### `user/event`
- Get events on an account, by pubkey: `user/event/_search?q=issuer:<pubkey>` (GET)
- Search on events: `user/event/_search` (POST or GET)
#### `user/profile` #### `user/profile`
...@@ -171,21 +169,3 @@ Some additional fields are `description`, `socials`, `tags` and `avatar` : ...@@ -171,21 +169,3 @@ Some additional fields are `description`, `socials`, `tags` and `avatar` :
- Delete an existing invitation: `invitation/certification/_delete` (POST) - Delete an existing invitation: `invitation/certification/_delete` (POST)
- Search on invitations: `invitation/certification/_search` (POST or GET) - Search on invitations: `invitation/certification/_search` (POST or GET)
## ES GCHANGE API
### `market/*`
#### `market/category`
#### `market/record`
#### `market/comment`
### `registry/*`
#### `registry/category`
#### `registry/record`
#### `registry/comment`
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment