docs: capture protocol and implementation gaps

This commit is contained in:
2026-04-29 00:27:04 -04:00
parent 4a72e1e030
commit 1366f8c5fc
5 changed files with 114 additions and 0 deletions

56
openapi/openapi.yaml Normal file
View File

@@ -0,0 +1,56 @@
openapi: 3.1.0
info:
title: MD Hub Secure Foundation API
version: 0.1.0
servers:
- url: http://localhost:8080
paths:
/health:
get:
summary: Health check
operationId: getHealth
responses:
"200":
description: Healthy
content:
application/json:
schema:
type: object
properties:
status:
type: string
database:
type: string
contentStore:
type: string
/api/uploads:
post:
summary: Upload a single attachment
operationId: uploadAttachment
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
responses:
"201":
description: Attachment stored
/attachments/{hash}:
get:
summary: Download an attachment by content hash
operationId: getAttachment
parameters:
- in: path
name: hash
required: true
schema:
type: string
responses:
"200":
description: Attachment content