docs/openapi.json at main · mso-docs/docs · 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
{
    "openapi": "3.0.0",
    "info": {
        "title": "YML Display API",
        "version": "1.0.0",
        "description": "API for displaying YML files on Mintlify."
    },
    "paths": {
        "/display-yml": {
            "post": {
                "summary": "Display YML file",
                "description": "Accepts a YML file and returns a rendered view for Mintlify.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/x-yaml": {
                            "schema": {
                                "type": "string",
                                "description": "YML file content"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Rendered YML view",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "html": {
                                            "type": "string",
                                            "description": "Rendered HTML of the YML file"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Invalid YML file"
                    }
                }
            }
        }
    }
}