From b9696b4e83e95af5e244885c1a9a0a8526fea9d8 Mon Sep 17 00:00:00 2001 From: Dominik Chilla <43314918+chillout2k@users.noreply.github.com> Date: Mon, 31 Dec 2018 00:58:48 +0100 Subject: [PATCH] Update README.md --- README.md | 57 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 34 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 48624ae..bed1730 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,59 @@ # gulag Gulag quarantine -## curl examples -### get all QuarMail metadata -```curl -v -s http://127.0.0.1:9090/api/v1/quarmails | jq +## get all QuarMail metadata + +``` +curl -v -s http://127.0.0.1:9090/api/v1/quarmails | jq ``` -### get all QuarMail metadata + RFC822 messages -```curl -v -s http://127.0.0.1:9090/api/v1/quarmails?rfc822_message=1 | jq +## get all QuarMail metadata + RFC822 messages +``` +curl -v -s http://127.0.0.1:9090/api/v1/quarmails?rfc822_message=1 | jq ``` -### get QuarMails metadata by (jqgrid-style) filter -```curl -v -s -G --data-urlencode 'filters={"groupOp":"OR","rules":[{"field":"hdr_subject","op":"eq","data":"996 test from quar mit sync xyz"}]}' http://127.0.0.1:9090/api/v1/quarmails | jq +## get QuarMails metadata by (jqgrid-style) filter +``` + curl -v -s -G --data-urlencode 'filters={"groupOp":"OR","rules":[{"field":"hdr_subject","op":"eq","data":"996 test from quar mit sync xyz"}]}' http://127.0.0.1:9090/api/v1/quarmails | jq ``` -### delete a QuarMail by ID -```curl -v -s -X DELETE http://127.0.0.1:9090/api/v1/quarmails/141 | jq +## delete a QuarMail by ID +``` + curl -v -s -X DELETE http://127.0.0.1:9090/api/v1/quarmails/141 | jq ``` -### get a QuarMail´s metadata by ID -```curl -v -s http://127.0.0.1:9090/api/v1/quarmails/136 | jq +## get a QuarMail´s metadata by ID +``` + curl -v -s http://127.0.0.1:9090/api/v1/quarmails/136 | jq ``` -### get a QuarMail´s metadata by ID + RFC822 message -```curl -v -s http://127.0.0.1:9090/api/v1/quarmails/136?rfc822_message=1 | jq +## get a QuarMail´s metadata by ID + RFC822 message +``` + curl -v -s http://127.0.0.1:9090/api/v1/quarmails/136?rfc822_message=1 | jq ``` -### get all URIs of a QuarMail -```curl -v -s http://127.0.0.1:9090/api/v1/quarmails/136/uris | jq +## get all URIs of a QuarMail +``` +curl -v -s http://127.0.0.1:9090/api/v1/quarmails/136/uris | jq ``` -### get an URI of a QuarMail by ID -```curl -v -s http://127.0.0.1:9090/api/v1/quarmails/136/uris/249 | jq +## get an URI of a QuarMail by ID +``` +curl -v -s http://127.0.0.1:9090/api/v1/quarmails/136/uris/249 | jq ``` -### get all attachments metadata of a QuarMail -```curl -v -s http://127.0.0.1:9090/api/v1/quarmails/136/attachments | jq +## get all attachments metadata of a QuarMail +``` +curl -v -s http://127.0.0.1:9090/api/v1/quarmails/136/attachments | jq ``` -### get an attachments metadata of a QuarMail by ID -```curl -v -s http://127.0.0.1:9090/api/v1/quarmails/136/attachments/71 | jq +## get an attachments metadata of a QuarMail by ID +``` +curl -v -s http://127.0.0.1:9090/api/v1/quarmails/136/attachments/71 | jq ``` -### get an attachments metadata of a QuarMail by ID + attachment data -```curl -v -s http://127.0.0.1:9090/api/v1/quarmails/136/attachments/71?data=1 | jq +## get an attachments metadata of a QuarMail by ID + attachment data +``` +curl -v -s http://127.0.0.1:9090/api/v1/quarmails/136/attachments/71?data=1 | jq ```