tim
71d3c70fda
Status --> Statuses
...
Usage of singular resource names is discouraged in REST:
http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api
The plural of status is statuses:
http://english.stackexchange.com/questions/877/what-is-the-plural-form-of-status
2017-01-25 10:28:28 +01:00
tim
1086c3a5c4
POST /transactions status code to 202
...
According to https://www.ietf.org/rfc/rfc2616.txt a 201 Created status
code MUST only be returned when:
"The origin server MUST create the resource before returning the 201 status
code."
hence, a 202 Accepted's definition is more appropriate:
"The request has been accepted for processing, but the processing has not been
completed.
The entity returned with this response SHOULD include an indication of the
request's current status and either a pointer to a status monitor or some
estimate of when the user can expect the request to be fulfilled."
2017-01-25 10:27:52 +01:00
tim
f15a7f7e8b
Document conditions endpoint
2017-01-25 10:23:14 +01:00
Scott Sadler
04a78aacec
Merge remote-tracking branch 'origin/master' into inputs-outputs
2016-12-22 13:45:02 +01:00
Scott Sadler
27ad7b5092
s/fulfillments/inputs/g && s/conditions/outputs/g (docs changes)
2016-12-19 12:29:29 +01:00
troymc
71e52ccf3e
Fixed HTTP API docs re/ API Endpoint
2016-12-16 13:36:13 +01:00
troymc
10a697fa60
Fixed broken link to The Transaction Model
2016-12-11 16:23:39 +01:00
Sylvain Bellemare
3bdaf60acb
Fix docs building warnings
2016-12-08 11:45:41 +01:00
troymc
adde84970f
Fixed merge conflict in bigchaindb/__init__.py
2016-12-01 16:09:34 +01:00
Scott Sadler
49726c4a31
make html runs generation scripts for documentation, generates http server examples
2016-11-30 16:28:58 +01:00
troymc
9212bcbe24
Minor edit about tx depending on associated keypairs
2016-11-29 14:28:21 +01:00
Brett Sun
536d440837
Fix HTTP API docs for upcoming release
2016-11-29 11:42:13 +01:00
Scott Sadler
7dc9f52fe0
remove transaction timestamp
2016-11-22 13:03:30 +01:00
Troy McConaghy
8f24e10fdc
Docs: Noted unspents endpoint not yet implemented
2016-11-20 14:03:42 +01:00
Scott Sadler
9b4252a6c9
wording change to drivers&clients doc as requested by @ttmc
2016-11-16 15:28:01 +01:00
Scott Sadler
9951b61076
add some explanation to the client-drivers documentation page.
2016-11-16 15:28:01 +01:00
Scott Sadler
44e80ce2a0
link to CLI from drivers and clients section of documentation
2016-11-16 15:28:01 +01:00
Troy McConaghy
81250e6059
Docs/826/direct link from server docs to py driver docs ( #827 )
...
* Removed python-driver.md page in server docs
* In server docs, changed Py Driver docs link to a direct link
2016-11-16 14:24:05 +01:00
troymc
5bf213d873
Removed api_endpoint from HTTP API docs & wrote how API Root URL is truly determined
2016-11-15 16:20:18 +01:00
tim
5ef532976d
Corrections to render sphinx correctly
2016-11-15 13:46:39 +01:00
tim
f82f1add03
TransactionLinks --> URIs
2016-11-15 13:18:25 +01:00
tim
284411d881
PR Feedback
2016-11-15 13:18:25 +01:00
tim
93f3e9a06b
Document unspents endpoint
2016-11-15 13:18:25 +01:00
tim
74b1662a78
Format http api docs to 79 chars
2016-11-15 13:18:25 +01:00
tim
1c8fec730c
Format http api docs to 79 chars
2016-11-11 15:38:28 +01:00
Troy McConaghy
7ed82be0fe
Merge pull request #759 from bigchaindb/rm-docs-page-python-server-api-by-example
...
Removed docs page "The Python Server API by Example"
2016-10-28 12:05:53 +02:00
troymc
0fb9c7539a
Removed python-server-api-examples from index
2016-10-28 10:40:44 +02:00
troymc
97dd4eae85
Removed page python-server-api-examples.md
2016-10-28 10:39:26 +02:00
troymc
a52921e9ec
Updated the docs page about the HTTP API
2016-10-27 18:45:11 +02:00
troymc
cd2fd494ac
Moved docs directory to docs/server, except README.md
2016-10-27 14:09:24 +02:00
