markdown-security/openapi.json at main · SINENSIA/markdown-security · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
{
  "openapi": "3.1.0",
  "info": {
    "title": "markdown-security",
    "description": "HTTP microservice that validates and sanitizes Markdown payloads against an HTML-tag allowlist.",
    "version": "2.3.0",
    "license": {
      "name": "MIT",
      "identifier": "MIT"
    },
    "contact": {
      "name": "SINENSIA",
      "url": "https://github.com/SINENSIA/markdown-security"
    }
  },
  "servers": [
    {
      "url": "http://localhost:5001",
      "description": "Local development"
    }
  ],
  "paths": {
    "/validate": {
      "post": {
        "summary": "Validate and sanitize a Markdown payload",
        "operationId": "validateMarkdown",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": { "$ref": "#/components/schemas/ValidateRequest" }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Validation result. Always returned for well-formed input, regardless of safety.",
            "headers": {
              "x-request-id": { "$ref": "#/components/headers/RequestId" }
            },
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ValidateResponse" }
              }
            }
          },
          "400": {
            "description": "The request body fails schema validation (missing/invalid `markdown` field, unexpected fields, etc.).",
            "headers": {
              "x-request-id": { "$ref": "#/components/headers/RequestId" }
            },
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" }
              }
            }
          },
          "413": {
            "description": "Request body exceeds the 256kb limit.",
            "headers": {
              "x-request-id": { "$ref": "#/components/headers/RequestId" }
            }
          },
          "429": {
            "description": "Rate limit exceeded. Only returned when the service is started with a positive `RATE_LIMIT_RPM` env var. Includes `retry-after` and `ratelimit-*` headers.",
            "headers": {
              "x-request-id": { "$ref": "#/components/headers/RequestId" },
              "retry-after": {
                "description": "Seconds the client should wait before retrying.",
                "schema": { "type": "integer" }
              }
            },
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" }
              }
            }
          }
        }
      }
    },
    "/health": {
      "get": {
        "summary": "Liveness probe",
        "operationId": "health",
        "responses": {
          "200": {
            "description": "The service is up.",
            "headers": {
              "x-request-id": { "$ref": "#/components/headers/RequestId" }
            },
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/HealthResponse" }
              }
            }
          }
        }
      }
    },
    "/openapi.json": {
      "get": {
        "summary": "This OpenAPI document.",
        "operationId": "openapi",
        "responses": {
          "200": {
            "description": "The OpenAPI specification served by this service.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    }
  },
  "components": {
    "headers": {
      "RequestId": {
        "description": "Echoes the incoming x-request-id when it matches `^[a-zA-Z0-9_.-]{1,128}$`, otherwise a server-generated UUID.",
        "schema": { "type": "string" }
      }
    },
    "schemas": {
      "ValidateRequest": {
        "type": "object",
        "required": ["markdown"],
        "additionalProperties": false,
        "properties": {
          "markdown": {
            "type": "string",
            "minLength": 1,
            "description": "Raw Markdown input. The total request body must not exceed 256kb."
          }
        }
      },
      "ValidateResponse": {
        "type": "object",
        "required": ["safe", "message", "sanitized", "frontMatter"],
        "additionalProperties": false,
        "properties": {
          "safe": {
            "type": "boolean",
            "description": "True only if sanitization made no changes to the body and the front matter (if present) contained no HTML-like content."
          },
          "message": {
            "type": "string",
            "enum": ["Markdown is safe", "Markdown contains unsafe content"]
          },
          "sanitized": {
            "type": "string",
            "description": "The Markdown body, post-sanitization. Never includes the front-matter block."
          },
          "frontMatter": {
            "type": ["string", "null"],
            "description": "Raw YAML between the leading `---` markers. Returned verbatim (NOT sanitized). Null when the input has no front matter."
          }
        }
      },
      "HealthResponse": {
        "type": "object",
        "required": ["status"],
        "additionalProperties": false,
        "properties": {
          "status": {
            "type": "string",
            "const": "ok"
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "required": ["safe", "error"],
        "additionalProperties": false,
        "properties": {
          "safe": { "type": "boolean", "const": false },
          "error": { "type": "string" },
          "details": {
            "type": "array",
            "description": "Per-field validation errors when the request fails JSON Schema validation. The array reports the first violation found rather than all of them — exhaustive enumeration is intentionally disabled to avoid DoS amplification on adversarial inputs.",
            "items": {
              "type": "object",
              "required": ["field", "message"],
              "additionalProperties": false,
              "properties": {
                "field": { "type": "string" },
                "message": { "type": "string" }
              }
            }
          }
        }
      }
    }
  }
}