{
  "openapi": "3.0.0",
  "info": {
    "title": "n8n 公共 API",
    "version": "1.1.1"
  },
  "tags": [
    {
      "name": "SourceControl",
      "description": "源代码管理相关操作"
    }
  ],
  "servers": [
    {
      "url": "/api/v1",
      "description": "当前 n8n 实例（自托管版本的内置测试台）"
    },
    {
      "url": "{url}/api/v1",
      "description": "自托管 n8n 实例",
      "variables": {
        "url": {
          "default": "https://example.com"
        }
      }
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    },
    {
      "BearerAuth": []
    },
    {
      "CookieAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-N8N-API-KEY"
      },
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "CookieAuth": {
        "type": "apiKey",
        "in": "cookie",
        "name": "n8n-auth"
      }
    },
    "responses": {
      "badRequest": {
        "description": "请求无效，或提供的数据格式错误。"
      },
      "unauthorized": {
        "description": "未授权"
      },
      "forbidden": {
        "description": "禁止访问"
      }
    }
  },
  "paths": {
    "/source-control/status": {
      "get": {
        "operationId": "getSourceControlStatus",
        "tags": [
          "SourceControl"
        ],
        "summary": "预览待处理的源代码管理变更",
        "description": "按 `push` 或 `pull` 方向，预览实例与已连接 Git 分支之间的待处理变更。",
        "parameters": [
          {
            "schema": {
              "type": "string",
              "enum": [
                "push",
                "pull"
              ]
            },
            "required": true,
            "name": "direction",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "操作成功。",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "file": {
                            "type": "string"
                          },
                          "id": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "credential",
                              "workflow",
                              "tags",
                              "variables",
                              "file",
                              "folders",
                              "project",
                              "datatable"
                            ]
                          },
                          "status": {
                            "type": "string",
                            "enum": [
                              "new",
                              "modified",
                              "deleted",
                              "created",
                              "renamed",
                              "conflicted",
                              "ignored",
                              "staged",
                              "unknown"
                            ]
                          },
                          "location": {
                            "type": "string",
                            "enum": [
                              "local",
                              "remote"
                            ]
                          },
                          "conflict": {
                            "type": "boolean"
                          },
                          "updatedAt": {
                            "type": "string"
                          },
                          "pushed": {
                            "type": "boolean"
                          },
                          "isLocalPublished": {
                            "type": "boolean"
                          },
                          "isRemoteArchived": {
                            "type": "boolean"
                          },
                          "parentFolderId": {
                            "type": "string",
                            "nullable": true
                          },
                          "folderPath": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          },
                          "remoteFolderPath": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          },
                          "owner": {
                            "type": "object",
                            "properties": {
                              "type": {
                                "type": "string",
                                "enum": [
                                  "personal",
                                  "team"
                                ]
                              },
                              "projectId": {
                                "type": "string"
                              },
                              "projectName": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "type",
                              "projectId",
                              "projectName"
                            ]
                          },
                          "publishingError": {
                            "type": "string"
                          },
                          "publishingErrorDetails": {
                            "type": "object",
                            "properties": {
                              "reason": {
                                "type": "string",
                                "enum": [
                                  "review_pending",
                                  "changes_requested",
                                  "insufficient_api_key_scope",
                                  "insufficient_permissions"
                                ]
                              },
                              "workflowReviewRequestId": {
                                "type": "string",
                                "minLength": 1
                              },
                              "versionId": {
                                "type": "string",
                                "minLength": 1
                              }
                            },
                            "required": [
                              "reason"
                            ],
                            "additionalProperties": false
                          },
                          "contentImportPolicy": {
                            "type": "object",
                            "properties": {
                              "violations": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "kind": {
                                      "type": "string"
                                    },
                                    "checkId": {
                                      "type": "string"
                                    },
                                    "message": {
                                      "type": "string"
                                    },
                                    "subject": {
                                      "type": "string"
                                    },
                                    "subjectType": {
                                      "type": "string"
                                    },
                                    "scope": {
                                      "type": "string"
                                    },
                                    "matchedRuleId": {
                                      "type": "string"
                                    },
                                    "projectId": {
                                      "type": "string"
                                    },
                                    "optInAvailable": {
                                      "type": "boolean"
                                    }
                                  },
                                  "required": [
                                    "kind",
                                    "checkId",
                                    "message"
                                  ]
                                }
                              },
                              "checkErrors": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "checkId": {
                                      "type": "string"
                                    },
                                    "correlationId": {
                                      "type": "string"
                                    }
                                  },
                                  "required": [
                                    "checkId",
                                    "correlationId"
                                  ]
                                }
                              }
                            },
                            "required": [
                              "violations",
                              "checkErrors"
                            ]
                          }
                        },
                        "required": [
                          "file",
                          "id",
                          "name",
                          "type",
                          "status",
                          "location",
                          "conflict",
                          "updatedAt"
                        ]
                      }
                    }
                  },
                  "required": [
                    "data"
                  ]
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/badRequest"
          },
          "401": {
            "$ref": "#/components/responses/unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/forbidden"
          }
        }
      }
    }
  }
}