{
  "openapi": "3.0.3",
  "info": {
    "title": "ISOPILOT Integration API",
    "version": "1.0.0",
    "description": "Tenant-scoped API for projects, documents, controlled external revisions, locks and webhooks."
  },
  "servers": [
    {
      "url": "https://isopilot.it/api/v1"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/oauth/token": {
      "post": {
        "security": [],
        "summary": "Issue an access token using client credentials",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "grant_type",
                  "client_id",
                  "client_secret"
                ],
                "properties": {
                  "grant_type": {
                    "type": "string",
                    "enum": [
                      "client_credentials"
                    ]
                  },
                  "client_id": {
                    "type": "string"
                  },
                  "client_secret": {
                    "type": "string"
                  },
                  "ttl": {
                    "type": "integer",
                    "minimum": 300,
                    "maximum": 86400,
                    "default": 3600
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Bearer token issued"
          },
          "401": {
            "description": "Invalid client"
          }
        }
      }
    },
    "/projects": {
      "get": {
        "summary": "List projects",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 50
            }
          },
          {
            "name": "offset",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Project list"
          }
        }
      }
    },
    "/projects/{projectId}": {
      "get": {
        "summary": "Read a project",
        "parameters": [
          {
            "$ref": "#/components/parameters/ProjectId"
          }
        ],
        "responses": {
          "200": {
            "description": "Project"
          },
          "400": {
            "description": "Project not found or invalid request"
          }
        }
      }
    },
    "/projects/{projectId}/documents": {
      "get": {
        "summary": "List project documents",
        "parameters": [
          {
            "$ref": "#/components/parameters/ProjectId"
          }
        ],
        "responses": {
          "200": {
            "description": "Documents"
          }
        }
      }
    },
    "/projects/{projectId}/files": {
      "get": {
        "summary": "List safe project-file metadata",
        "parameters": [
          {
            "$ref": "#/components/parameters/ProjectId"
          }
        ],
        "responses": {
          "200": {
            "description": "Project-file metadata; storage paths are not exposed"
          }
        }
      }
    },
    "/documents/{documentId}": {
      "get": {
        "summary": "Read a document and its version index",
        "parameters": [
          {
            "$ref": "#/components/parameters/DocumentId"
          }
        ],
        "responses": {
          "200": {
            "description": "Document"
          }
        }
      }
    },
    "/documents/{documentId}/versions/{versionId}": {
      "get": {
        "summary": "Read one document version",
        "parameters": [
          {
            "$ref": "#/components/parameters/DocumentId"
          },
          {
            "name": "versionId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Version with ETag-compatible content hash"
          }
        }
      }
    },
    "/documents/{documentId}/external-revisions": {
      "post": {
        "summary": "Stage a candidate external revision",
        "parameters": [
          {
            "$ref": "#/components/parameters/DocumentId"
          },
          {
            "name": "If-Match",
            "in": "header",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Current base-version content hash"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "content"
                ],
                "properties": {
                  "base_version_id": {
                    "type": "integer"
                  },
                  "content": {
                    "type": "object",
                    "description": "Structured ISOPILOT document content"
                  },
                  "html": {
                    "type": "string",
                    "description": "Optional preview only"
                  },
                  "source_reference": {
                    "type": "string",
                    "maxLength": 500
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Candidate revision staged"
          },
          "400": {
            "description": "Validation or version conflict"
          }
        }
      }
    },
    "/documents/{documentId}/checkout": {
      "post": {
        "summary": "Acquire a temporary document lock",
        "parameters": [
          {
            "$ref": "#/components/parameters/DocumentId"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "ttl_minutes": {
                    "type": "integer",
                    "minimum": 5,
                    "maximum": 240,
                    "default": 30
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "One-time lock token and expiry"
          }
        }
      }
    },
    "/documents/{documentId}/checkin": {
      "post": {
        "summary": "Release a document lock",
        "parameters": [
          {
            "$ref": "#/components/parameters/DocumentId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "lock_token"
                ],
                "properties": {
                  "lock_token": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Lock released"
          }
        }
      }
    },
    "/webhooks": {
      "get": {
        "summary": "List configured webhooks",
        "responses": {
          "200": {
            "description": "Safe webhook metadata; encrypted secret is never exposed"
          }
        }
      },
      "post": {
        "summary": "Create a webhook",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "name",
                  "endpoint_url",
                  "events"
                ],
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "endpoint_url": {
                    "type": "string",
                    "format": "uri"
                  },
                  "events": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Webhook created; signing secret returned once"
          }
        }
      }
    },
    "/webhooks/{webhookId}/status": {
      "post": {
        "summary": "Pause, activate or irreversibly revoke a webhook",
        "parameters": [
          {
            "name": "webhookId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "status"
                ],
                "properties": {
                  "status": {
                    "type": "string",
                    "enum": [
                      "active",
                      "paused",
                      "revoked"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Status updated"
          }
        }
      }
    },
    "/webhook-deliveries": {
      "get": {
        "summary": "List recent webhook delivery status",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 50
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Delivery status list"
          }
        }
      }
    },
    "/webhook-deliveries/{deliveryId}/replay": {
      "post": {
        "summary": "Requeue a failed/retry delivery for a non-revoked webhook",
        "parameters": [
          {
            "name": "deliveryId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Delivery queued"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "ISOPILOT"
      }
    },
    "parameters": {
      "ProjectId": {
        "name": "projectId",
        "in": "path",
        "required": true,
        "schema": {
          "type": "integer"
        }
      },
      "DocumentId": {
        "name": "documentId",
        "in": "path",
        "required": true,
        "schema": {
          "type": "integer"
        }
      }
    }
  }
}