{"openapi":"3.1.0","info":{"title":"Rumata Documentation API","version":"1.0.0","description":"Public read-only documentation. Does not operate Rumata accounts or resources."},"servers":[{"url":"/"},{"url":"https://docs.rumata.dev"}],"paths":{"/api/docs":{"get":{"operationId":"listDocs","summary":"List all guides","responses":{"200":{"description":"Success","headers":{"ETag":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Catalog"}}}},"304":{"description":"Unchanged"}}}},"/api/docs/{slug}":{"get":{"operationId":"getDoc","summary":"Read a guide","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"}},{"name":"audience","in":"query","schema":{"type":"string","enum":["general","technical"],"default":"technical"},"description":"general omits technical sections; technical includes both layers."},{"name":"format","in":"query","schema":{"type":"string","enum":["json","markdown"],"default":"json"}}],"responses":{"200":{"description":"Success","headers":{"ETag":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Guide"}},"text/markdown":{"schema":{"type":"string"}}}},"304":{"description":"Unchanged"},"400":{"description":"Invalid request or unknown document","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}},"404":{"description":"Invalid request or unknown document","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}}}},"/api/search":{"get":{"operationId":"searchDocs","summary":"Search guide sections","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":20,"default":8}},{"name":"audience","in":"query","schema":{"type":"string","enum":["general","technical"],"default":"technical"},"description":"general omits technical sections; technical includes both layers."}],"responses":{"200":{"description":"Success","headers":{"ETag":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["schemaVersion","contentVersion","query","results"],"properties":{"schemaVersion":{"type":"string"},"contentVersion":{"type":"string"},"query":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"}}}}}}},"400":{"description":"Invalid request or unknown document","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}}}}}}}},"/llms.txt":{"get":{"operationId":"getAgentIndex","responses":{"200":{"description":"Agent-readable index","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/llms-full.txt":{"get":{"operationId":"getFullCorpus","responses":{"200":{"description":"Full documentation in Markdown","content":{"text/plain":{"schema":{"type":"string"}}}}}}}},"components":{"schemas":{"Catalog":{"type":"object","required":["schemaVersion","contentVersion","documents"],"properties":{"schemaVersion":{"type":"string"},"contentVersion":{"type":"string"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentSummary"}}}},"DocumentSummary":{"type":"object","required":["slug","title","summary","category","updated","url","json"],"properties":{"slug":{"type":"string"},"title":{"type":"string"},"summary":{"type":"string"},"category":{"type":"string"},"updated":{"type":"string"},"url":{"type":"string"},"json":{"type":"string"}}},"Guide":{"type":"object","required":["schemaVersion","contentVersion","slug","title","summary","prerequisites","sections","technical","related","audience","url"],"properties":{"schemaVersion":{"type":"string"},"contentVersion":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"summary":{"type":"string"},"category":{"type":"string"},"minutes":{"type":"integer"},"updated":{"type":"string","format":"date"},"audience":{"type":"string","enum":["general","technical"]},"url":{"type":"string"},"prerequisites":{"type":"array","items":{"type":"string"}},"sections":{"type":"array","items":{"$ref":"#/components/schemas/Section"}},"technical":{"type":"array","items":{"$ref":"#/components/schemas/Section"}},"related":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"type":"string"}},"resources":{"type":"array","items":{"type":"object","required":["title","url"],"properties":{"title":{"type":"string"},"url":{"type":"string","format":"uri"}}}},"media":{"type":"array","items":{"$ref":"#/components/schemas/ProductMedia"}},"video":{"oneOf":[{"$ref":"#/components/schemas/Video"},{"type":"null"}]}}},"ProductMedia":{"type":"object","required":["src","alt","caption","width","height"],"properties":{"src":{"type":"string","format":"uri"},"sectionId":{"type":"string"},"alt":{"type":"string"},"caption":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}}},"Video":{"type":"object","required":["src","captions","poster","title","description","transcript"],"properties":{"src":{"type":"string","format":"uri"},"captions":{"type":"string","format":"uri"},"poster":{"type":"string","format":"uri"},"title":{"type":"string"},"description":{"type":"string"},"transcript":{"type":"array","items":{"type":"string"}}}},"Section":{"type":"object","required":["id","title","blocks"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/Block"}}}},"Block":{"oneOf":[{"type":"object","required":["type","items"],"properties":{"type":{"const":"faq"},"items":{"type":"array","items":{"type":"object","required":["question","answer"],"properties":{"question":{"type":"string"},"answer":{"type":"string"}}}}}},{"type":"object","required":["type","text"],"properties":{"type":{"enum":["paragraph"]},"text":{"type":"string"}}},{"type":"object","required":["type","items"],"properties":{"type":{"enum":["list","steps"]},"items":{"type":"array","items":{"type":"string"}}}},{"type":"object","required":["type","title","text"],"properties":{"type":{"const":"note"},"title":{"type":"string"},"text":{"type":"string"}}},{"type":"object","required":["type","language","text"],"properties":{"type":{"const":"code"},"language":{"type":"string"},"text":{"type":"string"}}},{"type":"object","required":["type","headers","rows"],"properties":{"type":{"const":"table"},"headers":{"type":"array","items":{"type":"string"}},"rows":{"type":"array","items":{"type":"array","items":{"type":"string"}}}}}]},"SearchResult":{"type":"object","required":["slug","title","section","sectionId","snippet","url","technical","score"],"properties":{"slug":{"type":"string"},"title":{"type":"string"},"section":{"type":"string"},"sectionId":{"type":"string"},"snippet":{"type":"string"},"url":{"type":"string"},"technical":{"type":"boolean"},"score":{"type":"number"}}}}}}