Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.01 KB

README.md

File metadata and controls

42 lines (29 loc) · 1.01 KB

Install

Configs

Set environment variable RACK_ENV to production if in production. This will make the API listen on port 80 instead of port 4567.

API Documentation

POST /clean

Parameters

Required

  • String html
    • HTML content to be cleaned.

Optional

  • Bool with_warnings (default: 0)

    • When 1, warnings are returned.

  • Bool remove_comments (default: 0)

    • When 1, HTML comments are removed.

  • Bool remove_script_tags (default: 0)

    • When 1, script tags are removed.

Response

{
    "html": "<form style=\"opacity: 0.5; color: red;\"><button>submit</button></form>",
    "warnings": [{
        "level": "RISKY",
        "message": "opacity CSS property",
        "clients": "Outlook 03, Outlook 07, Windows Mail, Entourage 2004, Notes 6, Eudora, New     Yahoo, Old GMail, New GMail, Live Mail, Hotmail"
    }, {
        "level": "SAFE",
        "message": "color CSS property",
        "clients": "Eudora"
    }]
}