updated barrel http api file
parent
d4a1d6d108
commit
dd9030d721
|
@ -5,40 +5,87 @@
|
|||
|
||||
"metadata": {
|
||||
"sourceName": "Barrel",
|
||||
"sourceUrl" : "https://docs.barrel.org/"
|
||||
"sourceUrl" : "https://docs.barrel-db.org/reference"
|
||||
},
|
||||
|
||||
"aliases": [
|
||||
"first alias", "second alias", "etc"
|
||||
],
|
||||
|
||||
"template_type": "terminal",
|
||||
|
||||
"section_order": [
|
||||
"First Section",
|
||||
"Second Section"
|
||||
"Barrel Commands",
|
||||
"Barrel API",
|
||||
"Document API"
|
||||
],
|
||||
|
||||
"sections": {
|
||||
"First Section": [
|
||||
|
||||
"Barrel Commands": [
|
||||
{
|
||||
"key": "Key 1.1",
|
||||
"val": "Value 1.1"
|
||||
"key": "barrel start",
|
||||
"val": "starts a barrel instance"
|
||||
},
|
||||
{
|
||||
"key": "Key 1.2",
|
||||
"val": "Value 1.2"
|
||||
"key": "barrel stop",
|
||||
"val": "stops the barrel instane"
|
||||
},
|
||||
{
|
||||
"key": "barrel console",
|
||||
"val": "starts the barrel console"
|
||||
}
|
||||
],
|
||||
"Second Section": [
|
||||
|
||||
"Barrel API": [
|
||||
{
|
||||
"key": "Key 2.1",
|
||||
"val": "Value 2.2"
|
||||
"key": "localhost:5984",
|
||||
"val": "retrieves information about this node (GET)"
|
||||
},
|
||||
{
|
||||
"key": "Key 2.2",
|
||||
"val": "Value 2.2"
|
||||
"key": "localhost:5984/_active_tasks",
|
||||
"val": "retrieves the list of active tasks (GET)"
|
||||
},
|
||||
{
|
||||
"key": "localhost:5984/_all_dbs",
|
||||
"val": "retrieves the list of database names (GET)"
|
||||
},
|
||||
{
|
||||
"key": "localhost:5984/_config",
|
||||
"val": "retrieves the barrel configuration (GET)"
|
||||
},
|
||||
{
|
||||
"key": "localhost:5984/_db_updates",
|
||||
"val": "retrieves the latest database change (GET)"
|
||||
},
|
||||
{
|
||||
"key": "localhost:5984/_log",
|
||||
"val": "tails the main log file (GET)"
|
||||
},
|
||||
{
|
||||
"key": "localhost:5984/_stats",
|
||||
"val": "statistics about the current node (GET)"
|
||||
},
|
||||
{
|
||||
"key": "localhost:5984/_uuids",
|
||||
"val": "UUIDs generated by Barrel (GET)"
|
||||
}
|
||||
],
|
||||
|
||||
"Document API": [
|
||||
{
|
||||
"key": "localhost:5984/{db_name}",
|
||||
"val": "creates a new database (POST)"
|
||||
},
|
||||
{
|
||||
"key": "localhost:5984/{db_name}",
|
||||
"val": "returns database information (GET)"
|
||||
},
|
||||
{
|
||||
"key": "localhost:5984/{db_name}/_all_docs",
|
||||
"val": "returns all the documents in the database (GET)"
|
||||
},
|
||||
{
|
||||
"key": "localhost:5984/{db_name}/{doc_id}",
|
||||
"val": "returns the document (GET)"
|
||||
}
|
||||
]
|
||||
|
||||
}
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue