Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Unified Diff: sitescripts/reports/README.md

Issue 29584613: #4431 - Introduce sitescripts.reports.web.resolveReport handler (Closed)
Patch Set: Address comments on PS1 Created Oct. 24, 2017, 3:35 p.m.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | sitescripts/reports/tests/test_resolveReport.py » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: sitescripts/reports/README.md
===================================================================
new file mode 100644
--- /dev/null
+++ b/sitescripts/reports/README.md
@@ -0,0 +1,29 @@
+# Scripts and web handlers for reports
+
+## resolveReport
+
+This handler is mounted under `/resolveReport` and should be called as follows:
+
+ http://<hostname>/<prefix>/resolveReport?<encrypted-report-id>
+
+If the report id is successfully decrypted, a `302 Found` response will be
+returned redirectring to the url of the report. If the encrypted report id
+is in the wrong format or encryption fails, a `404 Not Found` response will be
+returned.
+
+### Configuration
+
+The handler is configured via sitescripts config. In order to activate this
+handler, add the following line to multiplexer config:
+
+ [multiplexer]
+ sitescripts.reports.web.resolveReport =
+
+Its own configuration is in the section `reports_anonymization`:
+
+ [reports_anonymization]
+ encryption_key = <base64-encrypted-key>
+ redirect_url = https://target.host.com/reports/{report_id}
+
+The redirect URL could be any string. `{report_id}` will be replaced by
+the decrypted id of the report.
« no previous file with comments | « no previous file | sitescripts/reports/tests/test_resolveReport.py » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld