-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.live.json
More file actions
1 lines (1 loc) · 8.43 KB
/
openapi.live.json
File metadata and controls
1 lines (1 loc) · 8.43 KB
1
{"openapi":"3.1.0","info":{"title":"MCC Dossiers API","version":"0.1.0"},"paths":{"/health":{"get":{"summary":"Health","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/search":{"get":{"summary":"Search","operationId":"search_search_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string","default":"","title":"Q"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dossiers/{company_id}":{"get":{"summary":"Get Dossier","operationId":"get_dossier_dossiers__company_id__get","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/companies:upsert":{"post":{"summary":"Companies Upsert","description":"Upsert company without direct DB access","operationId":"companies_upsert_companies_upsert_post","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Payload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/patches:propose":{"post":{"summary":"Propose","operationId":"propose_patches_propose_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patch"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/patches:apply":{"post":{"summary":"Apply","operationId":"apply_patches_apply_post","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patch"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/documents:upload":{"post":{"summary":"Documents Upload","operationId":"documents_upload_documents_upload_post","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Payload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/embeddings:index":{"post":{"summary":"Embeddings Index","operationId":"embeddings_index_embeddings_index_post","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Payload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dev/seed":{"post":{"summary":"Seed","operationId":"seed_dev_seed_post","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ContactsBundle":{"properties":{"sensitive":{"type":"boolean","title":"Sensitive","default":true},"contacts":{"items":{"type":"object"},"type":"array","title":"Contacts","default":[]},"addresses":{"items":{"type":"object"},"type":"array","title":"Addresses","default":[]},"banking":{"type":"object","title":"Banking","default":{}}},"type":"object","title":"ContactsBundle"},"Document":{"properties":{"doc_id":{"type":"string","title":"Doc Id"},"title":{"type":"string","title":"Title"},"kind":{"type":"string","enum":["board_deck","financials","contract","exit_memo","kpi","other"],"title":"Kind"},"blob_url":{"type":"string","title":"Blob Url"},"sha256":{"type":"string","title":"Sha256"},"pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pages"},"embeddings_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Embeddings Id"}},"type":"object","required":["doc_id","title","kind","blob_url","sha256"],"title":"Document"},"Event":{"properties":{"event_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Id"},"date":{"type":"string","format":"date","title":"Date"},"type":{"type":"string","enum":["investment","distribution","repayment","conversion","info"],"title":"Type"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","default":"USD"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtype"},"instrument":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instrument"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"party_in":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Party In"},"party_out":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Party Out"}},"type":"object","required":["date","type"],"title":"Event"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Patch":{"properties":{"company_id":{"type":"string","title":"Company Id"},"dossier_overrides":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Dossier Overrides"},"events_to_append":{"items":{"$ref":"#/components/schemas/Event"},"type":"array","title":"Events To Append","default":[]},"updates_to_append":{"items":{"$ref":"#/components/schemas/Update"},"type":"array","title":"Updates To Append","default":[]},"documents_to_register":{"items":{"$ref":"#/components/schemas/Document"},"type":"array","title":"Documents To Register","default":[]},"contacts_to_set":{"anyOf":[{"$ref":"#/components/schemas/ContactsBundle"},{"type":"null"}]}},"type":"object","required":["company_id"],"title":"Patch"},"Update":{"properties":{"update_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Update Id"},"date":{"type":"string","format":"date","title":"Date"},"source_type":{"type":"string","enum":["email","pdf","call","memo","slack"],"title":"Source Type"},"source_ref":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Ref"},"update_type":{"type":"string","enum":["general","financial","fundraising","loan","ops","product"],"title":"Update Type"},"headline":{"type":"string","title":"Headline"},"body_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Text"},"structured_data":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Structured Data"}},"type":"object","required":["date","source_type","update_type","headline"],"title":"Update"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"ValidationResult":{"properties":{"ok":{"type":"boolean","title":"Ok"},"confidence":{"type":"number","title":"Confidence","default":0.0},"warnings":{"items":{"type":"string"},"type":"array","title":"Warnings","default":[]},"errors":{"items":{"type":"string"},"type":"array","title":"Errors","default":[]},"normalized_patch":{"anyOf":[{"$ref":"#/components/schemas/Patch"},{"type":"null"}]}},"type":"object","required":["ok"],"title":"ValidationResult"}}}}