From acff13d2b9af08476aae6be3865218edd719f235 Mon Sep 17 00:00:00 2001 From: Edwin O Marshall Date: Thu, 6 Mar 2014 17:48:39 -0500 Subject: [PATCH 1/3] - sep 10 for #629 --- sep/sep-010.rst | 70 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 sep/sep-010.rst diff --git a/sep/sep-010.rst b/sep/sep-010.rst new file mode 100644 index 000000000..831143891 --- /dev/null +++ b/sep/sep-010.rst @@ -0,0 +1,70 @@ +======= =========================================== +SEP 10 +Title REST API +Author Pablo Hoffman +Created 2009-11-16 +Status Obsolete (JSON-RPC API implemented instead) +======= =========================================== + +================= +SEP-010: REST API +================= + +This SEP proposes a JSON REST API for controlling Scrapy in server-mode, which +is launched with: ``scrapy-ctl.py start`` + +Operations +========== + +Get list of available spiders +----------------------------- + + GET /spiders/all + +Get list of closed spiders +-------------------------- + + GET /spiders/closed + +Get list of scheduled spiders +----------------------------- + + GET /spiders/scheduled + +.. note:: contains closed + +Get list of running spiders +--------------------------- + + GET /spiders/opened + +- returns list of dicts containing spider ``id`` and ``domain_name`` + +Schedule spider +--------------- + + POST /spiders + +- args: ``schedule=example.com`` + +Close spider +------------ + + POST /spider/1238/close + +Get global stats +---------------- + + GET /stats + +.. note:: spider-specific not included + +Get spider-specific stats +------------------------- + + GET /spider/1238/stats/ + +Get engine status +----------------- + + GET /engine/status From 3217d1d179b946a5f6e6b29f5cfd0f8e62c9146f Mon Sep 17 00:00:00 2001 From: Edwin O Marshall Date: Thu, 6 Mar 2014 17:50:41 -0500 Subject: [PATCH 2/3] - didn't like the way blockquotes rendered --- sep/sep-010.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/sep/sep-010.rst b/sep/sep-010.rst index 831143891..b6cb5c3e9 100644 --- a/sep/sep-010.rst +++ b/sep/sep-010.rst @@ -19,52 +19,52 @@ Operations Get list of available spiders ----------------------------- - GET /spiders/all +``GET /spiders/all`` Get list of closed spiders -------------------------- - GET /spiders/closed +``GET /spiders/closed`` Get list of scheduled spiders ----------------------------- - GET /spiders/scheduled +``GET /spiders/scheduled`` .. note:: contains closed Get list of running spiders --------------------------- - GET /spiders/opened +``GET /spiders/opened`` - returns list of dicts containing spider ``id`` and ``domain_name`` Schedule spider --------------- - POST /spiders +``POST /spiders`` - args: ``schedule=example.com`` Close spider ------------ - POST /spider/1238/close +``POST /spider/1238/close`` Get global stats ---------------- - GET /stats +``GET /stats`` .. note:: spider-specific not included Get spider-specific stats ------------------------- - GET /spider/1238/stats/ +``GET /spider/1238/stats/`` Get engine status ----------------- - GET /engine/status +``GET /engine/status`` From 8f0858cb0cd2d398000cfe9930617ae388763365 Mon Sep 17 00:00:00 2001 From: Edwin O Marshall Date: Fri, 7 Mar 2014 09:11:45 -0500 Subject: [PATCH 3/3] removed trac file --- sep/sep-010.trac | 59 ------------------------------------------------ 1 file changed, 59 deletions(-) delete mode 100644 sep/sep-010.trac diff --git a/sep/sep-010.trac b/sep/sep-010.trac deleted file mode 100644 index 4313fd0c3..000000000 --- a/sep/sep-010.trac +++ /dev/null @@ -1,59 +0,0 @@ -= SEP-010: REST API = - -[[PageOutline(2-5,Contents)]] - -||'''SEP:'''||10|| -||'''Title:'''||REST API|| -||'''Author:'''||Pablo Hoffman|| -||'''Created:'''||2009-11-16|| -||'''Status'''||Obsolete (JSON-RPC API implemented instead)|| - -== Introduction == - -This SEP proposes a JSON REST API for controlling Scrapy in server-mode, which is launched with: {{{scrapy-ctl.py start}}} - -== Operations == - -=== Get list of available spiders === - -GET /spiders/all - -=== Get list of closed spiders === - -GET /spiders/closed - -=== Get list of scheduled spiders === - -GET /spiders/scheduled - - * note: contains closed - -=== Get list of running spiders === - -GET /spiders/opened - - * returns list of dicts containing spider id and domain_name - -=== Schedule spider === - -POST /spiders - - * args: schedule=example.com - -=== Close spider === - -POST /spider/1238/close - -=== Get global stats === - -GET /stats - - * note: spider-specific not included - -=== Get spider-specific stats === - -GET /spider/1238/stats/ - -=== Get engine status === - -GET /engine/status