Skip to content
This repository was archived by the owner on Nov 27, 2023. It is now read-only.

Commit 49341e2

Browse files
authored
Merge pull request #19 from orbitdb/docs/https_update_fix_anchors
Docs/https update fix anchors
2 parents a7f536b + 5bf7ba8 commit 49341e2

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

README.md

+29-29
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@
2222
- [POST /db/:dbname/query](#post-dbdbnamequery)
2323
- [Modulus Query](#modulus-query)
2424
- [Range Query](#range-query)
25-
- [POST|PUT /db/:dbname/add](#post-put-dbdbnameadd)
26-
- [POST|PUT /db/:dbname/put](#post-put-dbdbnameput)
27-
- [POST|PUT /db/:dbname/inc](#post-put-dbdbnameinc)
28-
- [POST|PUT /db/:dbname/inc/:val](#post-put-dbdbnameincval)
29-
- [POST|PUT /db/:dbname/access/writ](#post-put-dbdbnameaccesswrite)
25+
- [POST|PUT /db/:dbname/add](#postput-dbdbnameadd)
26+
- [POST|PUT /db/:dbname/put](#postput-dbdbnameput)
27+
- [POST|PUT /db/:dbname/inc](#postput-dbdbnameinc)
28+
- [POST|PUT /db/:dbname/inc/:val](#postput-dbdbnameincval)
29+
- [POST|PUT /db/:dbname/access/writ](#postput-dbdbnameaccesswrite)
3030
- [DELETE /db/:dbname](#delete-dbdbname)
3131
- [DELETE /db/:dbname/:item](#delete-dbdbnameitem)
3232
- [Contribute](#contribute)
@@ -85,7 +85,7 @@ ignore the the insecure connection.
8585
Lists all databases on the current peer.
8686

8787
```shell
88-
curl http://localhost:3000/dbs
88+
curl https://localhost:3000/dbs
8989
```
9090

9191
```json
@@ -99,7 +99,7 @@ Gets the details of a database with name :dbname.
9999
Returns information about the database as a JSON object.
100100

101101
```shell
102-
curl http://localhost:3000/db/docstore
102+
curl https://localhost:3000/db/docstore
103103
```
104104

105105
```json
@@ -115,7 +115,7 @@ Returns the current counter value.
115115
Can only be used on counter.
116116

117117
```shell
118-
curl -X GET http://localhost:3000/db/counter/value
118+
curl -X GET https://localhost:3000/db/counter/value
119119
```
120120

121121
```json
@@ -131,7 +131,7 @@ Returns a list of found items as a JSON array.
131131
For the data type docstore, :item must be a value identified by the index field (set using indexBy).
132132

133133
```shell
134-
curl -X GET http://localhost:3000/db/docstore/1
134+
curl -X GET https://localhost:3000/db/docstore/1
135135
```
136136

137137
```json
@@ -147,7 +147,7 @@ Returns a list of matching objects as a JSON array.
147147
Can only be used on eventlog|feed.
148148

149149
```shell
150-
curl -X GET http://localhost:3000/db/feed/iterator
150+
curl -X GET https://localhost:3000/db/feed/iterator
151151
```
152152

153153
```json
@@ -157,7 +157,7 @@ curl -X GET http://localhost:3000/db/feed/iterator
157157
Additional options can be passed to OrbitDB to return different entries.
158158

159159
```shell
160-
curl -X GET http://localhost:3000/db/feed/iterator -d 'limit=-1'
160+
curl -X GET https://localhost:3000/db/feed/iterator -d 'limit=-1'
161161
```
162162

163163
```json
@@ -176,7 +176,7 @@ Returns information about the data stored as a JSON object.
176176
For the data store keyvalue all records are returned:
177177

178178
```shell
179-
curl -X GET http://localhost:3000/keyvalue/index
179+
curl -X GET https://localhost:3000/keyvalue/index
180180
```
181181

182182
```json
@@ -209,7 +209,7 @@ Gets the identity information.
209209
Returns identity as a JSON object.
210210

211211
```shell
212-
curl -X GET http://localhost:3000/identity
212+
curl -X GET https://localhost:3000/identity
213213
```
214214

215215
```json
@@ -227,7 +227,7 @@ The OrbitDB options ```create=true``` and ```type=eventlog|feed|docstore|keyvalu
227227
must be sent with the POST otherwise an error is thrown.
228228

229229
```shell
230-
curl http://localhost:3000/db/docstore -d "create=true" -d "type=docstore"
230+
curl https://localhost:3000/db/docstore -d "create=true" -d "type=docstore"
231231
```
232232

233233
```json
@@ -239,7 +239,7 @@ field must be changed then the indexBy flag can be specified as an additional
239239
POST param (this would apply to type docstore only):
240240

241241
```shell
242-
curl http://localhost:3000/db/docstore -d "create=true" -d "type=docstore" -d "indexBy=name"
242+
curl https://localhost:3000/db/docstore -d "create=true" -d "type=docstore" -d "indexBy=name"
243243
```
244244

245245
Parameters can also be passed as JSON. This is useful if additional parameters
@@ -255,15 +255,15 @@ database does not exist locally it will be fetched from the swarm.
255255
The address MUST be URL escaped.
256256

257257
```shell
258-
curl -X POST http://localhost:3000/db/zdpuAmnfJZ6UTssG5Ns3o8ALXZJXVx5eTLTxf7gfFzHxurbJq%2Fdocstore
258+
curl -X POST https://localhost:3000/db/zdpuAmnfJZ6UTssG5Ns3o8ALXZJXVx5eTLTxf7gfFzHxurbJq%2Fdocstore
259259
```
260260

261261
By default, OrbitDB will open the database if one already exists with the same
262262
name. To always overwrite the existing database with a new one, pass the
263263
overwrite flag:
264264

265265
```shell
266-
curl http://localhost:3000/db/docstore -d "create=true" -d "type=docstore" -d "overwrite=true"
266+
curl https://localhost:3000/db/docstore -d "create=true" -d "type=docstore" -d "overwrite=true"
267267
```
268268

269269
### POST /db/:dbname/query
@@ -273,7 +273,7 @@ Queries the database :dbname.
273273
Returns a list of found items as a JSON array.
274274

275275
```shell
276-
curl http://localhost:3000/db/docstore/query -X GET -H "Content-Type: application/json" --data '{"values":[]}'
276+
curl https://localhost:3000/db/docstore/query -X GET -H "Content-Type: application/json" --data '{"values":[]}'
277277
```
278278

279279
```json
@@ -284,7 +284,7 @@ To query a subset of data, a condition can be specified. For example, to
284284
retrieve only those entries which have a total number of likes above 300:
285285

286286
```shell
287-
curl http://localhost:3000/db/docstore/query -X GET -H "Content-Type: application/json" --data '{"propname":"likes","comp":">","values":[300]}'
287+
curl https://localhost:3000/db/docstore/query -X GET -H "Content-Type: application/json" --data '{"propname":"likes","comp":">","values":[300]}'
288288
```
289289

290290
```json
@@ -316,7 +316,7 @@ Available operator short-codes are:
316316
When using a modulus query, you must supply the divisor and the remainder. For example, to obtain all likes which are multiples of 100, you would specify a divisor 100 and a remainder 0:
317317

318318
```shell
319-
curl -X POST http://localhost:3000/db/docstore/query -H "Content-Type:application/json" --data '{"propname":"likes", "comp":"mod", "values":[100,0]}'
319+
curl -X POST https://localhost:3000/db/docstore/query -H "Content-Type:application/json" --data '{"propname":"likes", "comp":"mod", "values":[100,0]}'
320320
```
321321

322322
```json
@@ -329,7 +329,7 @@ When specifying a range query, you must supply the min and max
329329
values. For example, to obtain all likes greater than 250 but less than 1000 the min and max must be supplied:
330330

331331
```shell
332-
curl -X GET http://localhost:3000/db/docstore/query -H "Content-Type:application/json" --data '{"propname":"likes", "comp":"range", "values":[250,1000]}'
332+
curl -X GET https://localhost:3000/db/docstore/query -H "Content-Type:application/json" --data '{"propname":"likes", "comp":"range", "values":[250,1000]}'
333333
```
334334

335335
```json
@@ -345,7 +345,7 @@ Returns the multihash of the new record entry.
345345
Can only be used on eventlog|feed
346346

347347
```shell
348-
curl -X POST http://localhost:3000/db/feed/add -d 'feed-item-1'
348+
curl -X POST https://localhost:3000/db/feed/add -d 'feed-item-1'
349349
```
350350

351351
```json
@@ -359,7 +359,7 @@ Puts a record to the database :dbname.
359359
Returns a multihash of the record entry.
360360

361361
```shell
362-
curl -X POST http://localhost:3000/db/docstore/put -H "Content-Type: application/json" -d '{"_id":1, "value": "test"}'
362+
curl -X POST https://localhost:3000/db/docstore/put -H "Content-Type: application/json" -d '{"_id":1, "value": "test"}'
363363
```
364364

365365
```json
@@ -370,7 +370,7 @@ For the keyvalue store, a JSON object containing the variables `key` and
370370
`value` must be passed in the POST data:
371371

372372
```shell
373-
curl -X POST http://localhost:3000/db/keyvalue/put -H "Content-Type: application/json" -d '{"key":"Key","value":{ "name": "Value" }}'
373+
curl -X POST https://localhost:3000/db/keyvalue/put -H "Content-Type: application/json" -d '{"key":"Key","value":{ "name": "Value" }}'
374374
```
375375

376376
### POST|PUT /db/:dbname/inc
@@ -380,7 +380,7 @@ Increments the counter database :dbname by 1.
380380
Returns a multihash of the new counter value.
381381

382382
```shell
383-
curl -X POST http://localhost:3000/db/counter/inc
383+
curl -X POST https://localhost:3000/db/counter/inc
384384
```
385385

386386
```json
@@ -394,7 +394,7 @@ Increments the counter database :dbname by :val.
394394
Returns a multihash of the new counter value.
395395

396396
```shell
397-
curl -X POST http://localhost:3000/db/counter/inc/100
397+
curl -X POST https://localhost:3000/db/counter/inc/100
398398
```
399399

400400
```json
@@ -406,7 +406,7 @@ zdpuAmHw9Tcc4pyVjcVX3rJNJ7SGffmu4EwjodzmaPBVGGzbd
406406
Adds the id to the list of peers who have write access to the :dbname data store.
407407

408408
```shell
409-
curl -X POST http://localhost:3000/db/docstore/access/write -d 'id=045757bffcc7a4...'
409+
curl -X POST https://localhost:3000/db/docstore/access/write -d 'id=045757bffcc7a4...'
410410
```
411411

412412
```json
@@ -418,7 +418,7 @@ zdpuAmHw9Tcc4pyVjcVX3rJNJ7SGffmu4EwjodzmaPBVGGzbd
418418
Deletes the local database :dbname. This does not delete any data from peers.
419419

420420
```shell
421-
curl -X DELETE http://localhost:3000/db/docstore
421+
curl -X DELETE https://localhost:3000/db/docstore
422422
```
423423

424424
### DELETE /db/:dbname/:item
@@ -428,7 +428,7 @@ Deletes the item specified by :item from the database :dbname.
428428
Returns the multihash of the item entry deleted or an error if no item is found.
429429

430430
```shell
431-
curl -X DELETE http://localhost:3000/db/docstore/1
431+
curl -X DELETE https://localhost:3000/db/docstore/1
432432
```
433433

434434
```json

0 commit comments

Comments
 (0)