Jean-Paul Calderone
1f16a173f0
flatten the result structure
...
flat is better than nested
2017-07-27 15:32:47 -04:00
Jean-Paul Calderone
e0ee726d22
Update to the format the code now actually produces
2017-07-27 15:28:29 -04:00
Jean-Paul Calderone
780a932122
consistent markup
2017-07-27 15:26:30 -04:00
Jean-Paul Calderone
7b88cf376b
remove duplicate "above"
2017-07-27 15:26:30 -04:00
Jean-Paul Calderone
cc0e6ea6f9
typo fix
2017-07-27 15:26:30 -04:00
David Stainton
2006e6ae41
docs: add explaination of json welcome fields
2017-07-27 15:26:29 -04:00
David Stainton
a87822e66b
Add note about json welcome page to api docs
2017-07-27 15:26:29 -04:00
Brian Warner
705dc856eb
grammatical improvements
2017-06-06 11:28:23 +01:00
Daira Hopwood
2055a66cf2
Doc changes that require more careful review. refs #2345
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2017-06-06 11:20:49 +01:00
Daira Hopwood
4723af6e2f
LAFS now stands for "Least-Authority File Store" rather than "Least-Authority File System". refs #2345
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2017-06-06 11:20:49 +01:00
Vladimir Rusinov
b7e76c7f24
Document api-version field for deep-stats.
2016-12-23 22:50:48 -05:00
Brian Warner
c582a21e99
webapi.rst: fixups
...
Re-indent the blocks for consistency, improve the explanation of
?filename=foo.jpg to match it's new location, use new-style reference
for urls-and-utf8 footnote.
2016-04-22 19:23:49 -07:00
Zooko O'Whielacronx
3e7346100f
update webapi.rst's View/Download File docs
...
• mark "/file/" as a synonym for "/named/" to be deprecated (fixes #1903 )
• move the options common to all three forms to the bottom and dedent them
• name the protocol/format as "LAFS" and the implementation/client "Tahoe"
• reflow (with fill-column 77)
2016-04-22 19:17:22 -07:00
Brian Warner
f81900ee35
format docs for Sphinx
...
Added indexes, fixed cross-references.
Also a few pip-related cleanups I noticed along the way.
2016-03-30 01:26:47 -07:00
Brian Warner
259ba07a5e
improve HTTP byte-range docs
2015-07-28 13:28:36 -07:00
Brian Warner
c3608f61d9
webapi.rst: document Range: header on GET requests
...
closes ticket#2460
2015-07-28 13:15:50 -07:00
Daira Hopwood
0ef5939477
Remove 'needs-rebalancing' and add 'count-happiness' to checker reports; repair tests. fixes #1784 , #2105
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-03-20 16:13:57 +00:00
Zooko Wilcox-O'Hearn
0bebbe3290
fix warnings from rst2html
...
Apparently the in-line link syntax with "<>" in them causes these warnings. I
don't know why. I changed them all to a slightly more verbose syntax.
Thanks to Mike Kazantzsev's review comment
(https://github.com/tahoe-lafs/tahoe-lafs/pull/67#commitcomment-4561370 ), I
moved the links to the end of each section.
2013-11-11 22:04:11 +00:00
Zooko Wilcox-O'Hearn
82579cec96
magic first line tells emacs to use utf8+bom
...
Add ".. -*- coding: utf-8-with-signature -*-" to the first line of each .rst
file. This tells emacs to treat the file contents as utf-8, and also to prepend
a so-called utf-8 "bom" marker at the beginning of the file. This patch also
prepends those markers to each of those files.
2013-11-08 21:08:05 +00:00
Daira Hopwood
b06f8cd8d0
Add comments and a caveat in webapi.rst indicating that
...
the needs-rebalancing field may be computed incorrectly. refs #1115 , #1784 , #1477
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-18 23:48:45 +01:00
Daira Hopwood
6899d02854
Minor improvements to webapi.rst.
...
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-18 23:48:45 +01:00
Brian Warner
17fcafbb3f
docs: replace emdash characters with plain ASCII
2013-04-09 20:19:58 +01:00
Zooko O'Whielacronx
389251860e
attempt to clarify move-vs-relink
2013-04-09 07:08:17 -06:00
Brian Warner
f9335892f2
webapi.rst: small edits to the t=relink section
2013-04-09 12:06:52 +01:00
Daira Hopwood
b1064d456b
docs/frontends/webapi.rst: cosmetics.
...
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-05 19:38:43 +01:00
Daira Hopwood
35f37cc5b8
Change web-API to support t=relink instead of t=move (+ docs and tests). fixes #1732
...
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-05 19:38:43 +01:00
Mike Kazantsev
05d0b8b5b9
docs/frontends/webapi.rst: remove (ignored) "size" keyword from mkdir POST example
2012-10-09 15:01:44 -07:00
Brian Warner
fcc7e64759
Doc updates and cosmetic fixes for #1115 patch.
...
Removes the caveat from webapi.txt about count-good-share-hosts being wrong.
This series should close #1115 .
2012-05-13 01:15:50 -07:00
Brian Warner
2c5a7f7ba4
Improve webapi t=move docs.
2012-05-09 16:46:53 -07:00
Marcus Wanner
e58a01270b
Change the arbitrary URI support from implied to explicit
...
The move webapi function now takes a target_type argument which lets it
know whether the target is a subdirectory name or URI. This is an
improvement over the old system in which the move handler tried to guess
whether the target was a name or a URI. Also fixed a little docs
copypaste problem and tweaked some line wrapping.
2012-05-09 13:07:14 -07:00
Marcus Wanner
b29d0920d3
Adding 'move' button to web UI, closes #1579
...
This adds "move file" capability to the web UI's directory display. The
support and test framework is heavily based on the similar "rename file"
feature. Unit tests and documentation are included. Multiple in-progress
versions of this patch may be found in ticket 1579. This version
includes arbitrary URI target support and is compatible with the change
from tahoe_css to tahoe.css.
2012-05-09 13:07:13 -07:00
Patrick R McDonald
080c136daf
Updated webapi.rst to list /cap as a synonym for /uri
2012-04-17 11:41:11 -07:00
Patrick R McDonald
589179cf03
Fix for ticket #1662
2012-04-10 11:33:14 -07:00
Brian Warner
3a2a086f6c
webapi.rst: de-tabify
2012-04-02 16:32:05 -07:00
david-sarah
5495b2aead
Put SFTP before FTP in various docs. fixes #1692
2012-03-22 22:04:53 +00:00
david-sarah
07312870e1
Minor updates to URLs.
2012-03-13 20:28:53 +00:00
david-sarah
d9c7dfa4a0
Update more links from http: to https: in documentation and comments.
2012-03-13 20:26:54 +00:00
Brian Warner
11f9394704
remove 'provisioning'/'reliability' from WUI, add to misc/operations_helpers
...
Also remove docs related to reliability/provisioning pages
2012-02-16 22:29:05 +00:00
Brian Warner
05dbb1cf86
update project-home URLs: /trac/tahoe/ was replaced by /trac/tahoe-lafs/
2011-10-30 12:14:28 -07:00
Brian Warner
210761cd49
misc mutable-type fixes:
...
* fix tahoe.cfg control of default mutable type
* tolerate arbitrary case in [client]mutable.format value
* small docs improvements
* use get_mutable_type() as a format-is-mutable predicate
* tighten up error message
2011-10-13 09:32:29 -07:00
Brian Warner
01b00dc7dc
webapi: use all-caps "SDMF"/"MDMF" acronyms in t=json response
...
docs: upcase examples of t=json output and format= input
2011-10-13 09:31:43 -07:00
Brian Warner
8b91410ebb
webapi.rst: fix whitespace (detabify) t=json examples
2011-10-13 09:30:56 -07:00
kevan
bd642739cb
docs/frontends/webapi.rst: document the format argument
2011-10-09 19:55:29 -07:00
david-sarah
3d7a32647c
Implementation, tests and docs for blacklists. This version allows listing directories containing a blacklisted child. Inclusion of blacklist.py fixed. fixes #1425
2011-08-24 08:59:28 -07:00
Kevan Carstensen
85a00b2d37
docs: amend configuration, webapi documentation to talk about MDMF
2011-08-01 19:20:56 -07:00
david-sarah
9ba8a1b83e
docs/frontends/webapi.rst: change some more instances of 'delete' or 'remove' to 'unlink', change some section titles, and use two blank lines between all sections. refs #776 , #1104
2011-08-01 15:09:19 -07:00
david-sarah
00dccc4377
docs/webapi.rst: address Kevan's comments about use of 'delete' on ref #1104
2011-08-01 13:53:56 -07:00
david-sarah
07ecac1d83
WUI: change the label of the button to unlink a file from 'del' to 'unlink'. Also change some internal names to 'unlink', and allow 't=unlink' as a synonym for 't=delete' in the web-API interface. Incidentally, improve a test to check for the rename button as well as the unlink button. fixes #1104
2011-07-12 17:12:18 -07:00
david-sarah
be18ded062
docs/webapi.rst: typos.
2010-12-29 19:44:22 -08:00
david-sarah
53aeb3a3bc
docs/webapi.rst: capitalization, formatting of section on URL character encoding, and a correction about Internet Explorer.
2010-12-29 19:40:49 -08:00