16 Commits

Author	SHA1	Message	Date
Alex Osborne	507d7d91a3	docs: add getting-started.rst, configuring-jobs.rst and glossary.rst ... Compiled from the wiki with some restructuring, reformatting and updating for the current version of Heritrix.	2021-07-06 22:44:11 +09:00
Alex Osborne	f19dacfe67	Document GET /engine	2020-04-20 18:32:43 +09:00
Alex Osborne	f442f76784	Add missing newline	2020-04-20 12:47:17 +09:00
Alex Osborne	33e637b887	Correct indentation to 3-spaces for reST	2020-04-20 12:40:51 +09:00
Alex Osborne	75dc16e8ca	Document 'Get Job Status' endpoint	2020-04-20 12:35:49 +09:00
Andy Jackson	e08d3ad45d	Note feature only applies to forthcoming 3.3 release	2018-11-03 09:30:32 +00:00
Andrew Jackson	3a299d7899	Update API with note about checkpoint launching.	2018-11-01 20:20:17 +09:00
Alex Osborne	da9fcf1af6	Fix typos	2018-07-04 22:22:15 +09:00
Alex Osborne	2d48b40ea4	Replace API response section with statuscode tag	2018-07-04 21:46:42 +09:00
Alex Osborne	0cfd62f76e	Reformat the rest of the API calls	2018-07-04 21:43:57 +09:00
Alex Osborne	3b3d579cb8	Add actions to API URLs to distinguish them	2018-07-04 21:16:53 +09:00
Alex Osborne	7076dd6388	Try nicer formatting for the first API example	2018-07-04 18:46:15 +09:00
Alex Osborne	ab8a5efea2	Format HTTP request lines in API guide	2018-07-04 18:24:08 +09:00
Alex Osborne	e35eb9e850	Move conventions and REST section to the end of the document ... Let's dive right into the API. Chances are anyone who wants to use the REST API already knows what it is. :-)	2018-07-04 17:53:05 +09:00
Alex Osborne	57f465706e	Convert html tables to rst tables	2018-07-04 17:34:19 +09:00
Alex Osborne	90db2e33d5	Add skeleton sphinx docs for readthedocs	2018-07-04 16:40:51 +09:00