openapi: 3.0.1 info: title: Crawlab API description: REST API for Crawlab version: 0.7.0 paths: /data/collections: get: tags: - Data Collections summary: Get Data Collection List description: Get a list of items operationId: get_data_collection_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsDataCollection' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Data Collections summary: Create Data Collection description: Create a new item operationId: create_data_collection requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_data_collectionInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDataCollection' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Data Collections summary: Delete Data Collection List description: Delete multiple items operationId: delete_data_collection_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDataCollection' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Data Collections summary: Batch Update Data Collection List description: Batch update multiple items with partial fields operationId: batch_update_data_collection_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_data_collection_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDataCollection' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /data/collections/{id}: get: tags: - Data Collections summary: Get Data Collection by ID description: Get a single item by ID operationId: get_data_collection_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDataCollection' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Data Collections summary: Replace Data Collection by ID description: Replace an item by ID with (full update) operationId: replace_data_collection_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_data_collection_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDataCollection' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Data Collections summary: Delete Data Collection by ID description: Delete an item by ID operationId: delete_data_collection_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDataCollection' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Data Collections summary: Update Data Collection by ID description: Update an item by ID with (partial update) operationId: update_data_collection_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_data_collection_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDataCollection' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases: get: tags: - Databases summary: Get Database List description: Get the list of a database operationId: get_database_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsDatabase' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Databases summary: Create Database description: Create a new database operationId: create_database requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_databaseInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDatabase' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Databases summary: Delete Database List description: Delete multiple items operationId: delete_database_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDatabase' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Databases summary: Batch Update Database List description: Batch update multiple items with partial fields operationId: batch_update_database_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_database_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDatabase' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/metrics: get: tags: - Databases summary: Get Database Metrics description: Get the metrics of a database operationId: get_database_metrics parameters: - name: filter in: query description: Filter query for databases schema: type: string description: Filter query for databases - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: array items: $ref: '#/components/schemas/PrimitiveE' description: Sort options style: form explode: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubControllersGetDatabaseMetricsResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}: get: tags: - Databases summary: Get Database by ID description: Get a database by ID operationId: get_database_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDatabase' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Databases summary: Replace Database by ID description: Replace a database by ID (full update) operationId: replace_database_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_database_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDatabase' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Databases summary: Delete Database by ID description: Delete an item by ID operationId: delete_database_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDatabase' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Databases summary: Update Database by ID description: Update an item by ID with (partial update) operationId: update_database_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_database_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDatabase' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/columns/types: get: tags: - Databases summary: Get Database Column Types description: Get the column types of a database operationId: get_database_column_types parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid - name: query in: query description: SQL query to analyze for column types schema: type: string description: SQL query to analyze for column types responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseString' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/connection/test: post: tags: - Databases summary: Test Database Connection description: Test the connection of a database operationId: test_database_connection parameters: - name: id in: path description: ID of the database to test required: true schema: type: string description: ID of the database to test format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/export/{type}: post: tags: - Databases summary: Export Database description: Export a database operationId: export_database parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid - name: type in: path description: Type of export (csv, json) required: true schema: type: string description: Type of export (csv, json) - name: filter in: query description: Filter query for the export schema: type: string description: Filter query for the export - name: target in: query description: Export target required: true schema: type: string description: Export target responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseString' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/export/{type}/{exportId}: get: tags: - Databases summary: Get Database Export description: Get the export of a database operationId: get_database_export parameters: - name: exportId in: path description: ID of the export to retrieve required: true schema: type: string description: ID of the export to retrieve - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid - name: type in: path description: Type of export (csv, json) required: true schema: type: string description: Type of export (csv, json) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubInterfacesExport' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/export/{type}/{exportId}/download: get: tags: - Databases summary: Get Database Export Download description: Get the download of a database export operationId: get_database_export_download parameters: - name: exportId in: path description: ID of the export to download required: true schema: type: string description: ID of the export to download - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid - name: type in: path description: Type of export (csv, json) required: true schema: type: string description: Type of export (csv, json) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/metadata: get: tags: - Databases summary: Get Database Metadata description: Get the metadata of a database operationId: get_database_metadata parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubEntityDatabaseMetadata' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/metrics/current: get: tags: - Databases summary: Get Database Current Metrics by ID description: Get the current metrics of a database operationId: get_database_current_metrics_by_id parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponse*GithubModelsDatabaseMetric' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/metrics/time-range: get: tags: - Databases summary: Get Database Time Range Metrics by ID description: Get the time range metrics of a database operationId: get_database_time_range_metrics_by_id parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid - name: end in: query description: End time for the metrics range (RFC3339 format) schema: type: string description: End time for the metrics range (RFC3339 format) format: date-time - name: metric_names in: query description: Comma-separated list of metric names to retrieve required: true schema: type: string description: Comma-separated list of metric names to retrieve - name: start in: query description: Start time for the metrics range (RFC3339 format) schema: type: string description: Start time for the metrics range (RFC3339 format) format: date-time - name: time_unit in: query description: Time unit for the metrics (e.g., minute, hour, day) required: true schema: type: string description: Time unit for the metrics (e.g., minute, hour, day) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseMapStringInterface {}' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/orm/compatibility: get: tags: - Databases summary: Get Database ORM Compatibility description: Check ORM compatibility for a database operationId: get_database_orm_compatibility parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubControllersDatabaseOrmCompatibilityResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/orm/initialize: post: tags: - Databases summary: Initialize Database ORM description: Initialize ORM settings for a database operationId: initialize_database_orm parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/orm/status: get: tags: - Databases summary: Get Database ORM Status description: Get the ORM status of a database operationId: get_database_orm_status parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubControllersDatabaseOrmStatusResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Databases summary: Update Database ORM Status description: Enable or disable ORM for a database operationId: update_database_orm_status parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_database_orm_statusInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/query: post: tags: - Databases summary: Query Database description: Query a database operationId: query_database parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Query_databaseInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponse*GithubEntityDatabaseQueryResults' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/tables/create: post: tags: - Databases summary: Create Database Table description: Create a new table of a database operationId: create_database_table parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_database_tableInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/tables/data: get: tags: - Databases summary: Get Database Table Data description: Get the data of a table of a database operationId: get_database_table_data parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid - name: database in: query description: Name of the database schema: type: string description: Name of the database - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: table in: query description: Name of the table required: true schema: type: string description: Name of the table responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseMapStringInterface {}' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Databases summary: Create Database Table Data description: Create a new table of a database operationId: create_database_table_data parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_database_table_dataInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/tables/data/get: post: tags: - Databases summary: Get Database Table Data with Filter description: Get the data of a table of a database with filter operationId: get_database_table_data_with_filter parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Get_database_table_data_with_filterInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseMapStringInterface {}' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/tables/drop: delete: tags: - Databases summary: Drop Database Table description: Drop a table of a database operationId: drop_database_table parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/tables/metadata: get: tags: - Databases summary: Get Database Table Metadata description: Get the metadata of a table of a database operationId: get_database_table_metadata parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid - name: database in: query description: Name of the database schema: type: string description: Name of the database - name: table in: query description: Name of the table required: true schema: type: string description: Name of the table responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponse*GithubEntityDatabaseTable' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/tables/metadata/get: post: tags: - Databases summary: Get Database Table Metadata with Filter description: Get the metadata of a table of a database with filter operationId: get_database_table_metadata_with_filter parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Get_database_table_metadata_with_filterInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponse*GithubEntityDatabaseTable' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/tables/modify: post: tags: - Databases summary: Modify Database Table description: Modify a table of a database operationId: modify_database_table parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Modify_database_tableInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /databases/{id}/tables/rename: post: tags: - Databases summary: Rename Database Table description: Rename a table of a database operationId: rename_database_table parameters: - name: id in: path description: ID of the database required: true schema: type: string description: ID of the database format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Rename_database_tableInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /dependencies/configs/{lang}: get: tags: - Dependencies summary: Get Dependency Config description: Get the config of a dependency operationId: get_dependency_config parameters: - name: lang in: path description: The programming language of the dependency configuration required: true schema: type: string description: The programming language of the dependency configuration responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDependencyConfig' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Dependencies summary: Replace Dependency Config description: Replace the config of a dependency (full update) operationId: replace_dependency_config parameters: - name: lang in: path description: The programming language of the dependency configuration required: true schema: type: string description: The programming language of the dependency configuration requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_dependency_configInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /dependencies/configs/{lang}/setups: get: tags: - Dependencies summary: Get Dependency Config Setup List description: Get the setup list of a dependency operationId: get_dependency_config_setup_list parameters: - name: lang in: path description: The programming language of the dependency configuration required: true schema: type: string description: The programming language of the dependency configuration - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDependencyConfigSetup' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /dependencies/configs/{lang}/setups/install: post: tags: - Dependencies summary: Install Dependency Config Setup description: Install a setup of a dependency operationId: install_dependency_config_setup parameters: - name: lang in: path description: The programming language of the dependency configuration required: true schema: type: string description: The programming language of the dependency configuration requestBody: content: application/json: schema: $ref: '#/components/schemas/Install_dependency_config_setupInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /dependencies/configs/{lang}/setups/uninstall: post: tags: - Dependencies summary: Uninstall Dependency Config Setup description: Uninstall a setup of a dependency operationId: uninstall_dependency_config_setup parameters: - name: lang in: path description: The programming language of the dependency configuration required: true schema: type: string description: The programming language of the dependency configuration requestBody: content: application/json: schema: $ref: '#/components/schemas/Uninstall_dependency_config_setupInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /dependencies/configs/{lang}/versions: get: tags: - Dependencies summary: Get Dependency Config Versions description: Get the versions of a dependency operationId: get_dependency_config_versions parameters: - name: lang in: path description: The programming language of the dependency configuration required: true schema: type: string description: The programming language of the dependency configuration responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseString' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /dependencies/repos: get: tags: - Dependencies summary: Get Dependency Repo List description: Get the list of a dependency operationId: get_dependency_repo_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: lang in: query description: The programming language of the dependency repositories schema: type: string description: The programming language of the dependency repositories default: python - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubEntityDependencyRepo' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /dependencies/repos/install: post: tags: - Dependencies summary: Install Dependency description: Install a dependency operationId: install_dependency requestBody: content: application/json: schema: $ref: '#/components/schemas/Install_dependencyInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /dependencies/repos/search: get: tags: - Dependencies summary: Get Dependency Search Repo List description: Get the search list of a dependency operationId: get_dependency_search_repo_list parameters: - name: lang in: query description: The programming language of the dependency repositories required: true schema: type: string description: The programming language of the dependency repositories - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: query in: query description: The search query schema: type: string description: The search query - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubEntityDependencyRepo' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /dependencies/repos/uninstall: post: tags: - Dependencies summary: Uninstall Dependency description: Uninstall a dependency operationId: uninstall_dependency requestBody: content: application/json: schema: $ref: '#/components/schemas/Uninstall_dependencyInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /dependencies/repos/versions: get: tags: - Dependencies summary: Get Dependency Repo Version List description: Get the version list of a dependency operationId: get_dependency_repo_version_list parameters: - name: lang in: query description: The programming language of the dependency repository required: true schema: type: string description: The programming language of the dependency repository - name: repo in: query description: The name of the repository required: true schema: type: string description: The name of the repository responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseString' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /dependencies/settings: get: tags: - Dependencies summary: Get Dependencies Setting List description: Get a list of items operationId: get_dependencies_setting_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsDependencyConfig' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Dependencies summary: Create Dependencies Setting description: Create a new item operationId: create_dependencies_setting requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_dependencies_settingInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDependencyConfig' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Dependencies summary: Delete Dependencies Setting List description: Delete multiple items operationId: delete_dependencies_setting_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDependencyConfig' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Dependencies summary: Batch Update Dependencies Setting List description: Batch update multiple items with partial fields operationId: batch_update_dependencies_setting_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_dependencies_setting_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDependencyConfig' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /dependencies/settings/{id}: get: tags: - Dependencies summary: Get Dependencies Setting by ID description: Get a single item by ID operationId: get_dependencies_setting_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDependencyConfig' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Dependencies summary: Replace Dependencies Setting by ID description: Replace an item by ID with (full update) operationId: replace_dependencies_setting_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_dependencies_setting_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDependencyConfig' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Dependencies summary: Delete Dependencies Setting by ID description: Delete an item by ID operationId: delete_dependencies_setting_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDependencyConfig' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Dependencies summary: Update Dependencies Setting by ID description: Update an item by ID with (partial update) operationId: update_dependencies_setting_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_dependencies_setting_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDependencyConfig' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /dependencies/spiders/{id}: get: tags: - Dependencies summary: Get Dependency Spider Dependency List description: Get the dependency list of a spider operationId: get_dependency_spider_dependency_list parameters: - name: id in: path description: ID of the spider required: true schema: type: string description: ID of the spider format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubControllersGetDependencySpiderDependencyListResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /dependencies/spiders/{id}/install: post: tags: - Dependencies summary: Install Dependency Spider description: Install a dependency spider operationId: install_dependency_spider parameters: - name: id in: path description: ID of the spider required: true schema: type: string description: ID of the spider format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /dependencies/{id}/logs: get: tags: - Dependencies summary: Get Dependency Logs by ID description: Get the logs of a dependency operationId: get_dependency_logs_by_id parameters: - name: id in: path description: ID of the target to get logs for required: true schema: type: string description: ID of the target to get logs for format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsDependencyLog' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /environments: get: tags: - Environments summary: Get Environment List description: Get a list of items operationId: get_environment_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsEnvironment' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Environments summary: Create Environment description: Create a new item operationId: create_environment requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_environmentInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsEnvironment' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Environments summary: Delete Environment List description: Delete multiple items operationId: delete_environment_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsEnvironment' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Environments summary: Batch Update Environment List description: Batch update multiple items with partial fields operationId: batch_update_environment_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_environment_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsEnvironment' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /environments/{id}: get: tags: - Environments summary: Get Environment by ID description: Get a single item by ID operationId: get_environment_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsEnvironment' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Environments summary: Replace Environment by ID description: Replace an item by ID with (full update) operationId: replace_environment_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_environment_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsEnvironment' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Environments summary: Delete Environment by ID description: Delete an item by ID operationId: delete_environment_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsEnvironment' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Environments summary: Update Environment by ID description: Update an item by ID with (partial update) operationId: update_environment_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_environment_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsEnvironment' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /export/{type}: post: tags: - Export summary: Export Data description: Export data operationId: export_data parameters: - name: type in: path required: true schema: type: string - name: filter in: query description: Filter query schema: type: string description: Filter query - name: target in: query required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseString' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /export/{type}/{id}: get: tags: - Export summary: Get Export description: Get an export operationId: get_export parameters: - name: id in: path required: true schema: type: string - name: type in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubInterfacesExport' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /export/{type}/{id}/download: get: tags: - Export summary: Get Export Download description: Get an export download operationId: get_export_download parameters: - name: id in: path required: true schema: type: string - name: type in: path required: true schema: type: string responses: '200': description: OK '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /filters/{col}: get: tags: - Filters summary: Get Filter Column Field Options description: Get the field options of a collection operationId: get_filter_column_field_options parameters: - name: col in: path required: true schema: type: string - name: filter in: query description: Filter query schema: type: string description: Filter query responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubEntityFilterSelectOption' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /filters/{col}/{value}: get: tags: - Filters summary: Get Filter Col Field Options With Value description: Get the field options of a collection with a value operationId: get_filter_col_field_options_with_value parameters: - name: col in: path required: true schema: type: string - name: value in: path required: true schema: type: string - name: filter in: query description: Filter query schema: type: string description: Filter query responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubEntityFilterSelectOption' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /filters/{col}/{value}/{label}: get: tags: - Filters summary: Get Filter Col Field Options With Value And Label description: Get the field options of a collection with a value and label operationId: get_filter_col_field_options_with_value_and_label parameters: - name: col in: path required: true schema: type: string - name: label in: path required: true schema: type: string - name: value in: path required: true schema: type: string - name: filter in: query description: Filter query schema: type: string description: Filter query responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubEntityFilterSelectOption' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits: get: tags: - Git summary: Get Git List description: Get a list of gits operationId: get_git_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsGitDTO' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Git summary: Create Git description: Create a new git operationId: create_git requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_gitInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsGit' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Git summary: Delete Git List description: Delete a list of gits operationId: delete_git_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsGit' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Git summary: Batch Update Git List description: Batch update multiple items with partial fields operationId: batch_update_git_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_git_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsGit' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}: get: tags: - Git summary: Get Git by ID description: Get a git by ID operationId: get_git_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsGitDTO' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Git summary: Replace Git by ID description: Replace an item by ID with (full update) operationId: replace_git_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_git_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsGit' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Git summary: Delete Git by ID description: Delete a git by ID operationId: delete_git_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsGit' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Git summary: Update Git by ID description: Update an item by ID with (partial update) operationId: update_git_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_git_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsGit' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/branches: get: tags: - Git summary: Get Git Branches description: Get the branches of a git repository operationId: get_git_branches parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubVcsGitRef' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Git summary: Delete Git Branch description: Delete a branch of a git repository operationId: delete_git_branch parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/branches/checkout: post: tags: - Git summary: Checkout Git Branch description: Checkout a branch of a git repository operationId: checkout_git_branch parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Checkout_git_branchInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/branches/current: get: tags: - Git summary: Get Git Current Branch description: Get the current branch of a git repository operationId: get_git_current_branch parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubVcsGitRef' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/branches/new: post: tags: - Git summary: Create Git New Branch description: Create a new branch of a git repository operationId: create_git_new_branch parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_git_new_branchInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/branches/remote: get: tags: - Git summary: Get Git Remote Branches description: Get the remote branches of a git repository operationId: get_git_remote_branches parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubVcsGitRef' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/branches/remote/checkout: post: tags: - Git summary: Checkout Git Remote Branch description: Checkout a remote branch of a git repository operationId: checkout_git_remote_branch parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Checkout_git_remote_branchInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/changes: get: tags: - Git summary: Get Git Changes description: Get the changes of a git repository operationId: get_git_changes parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubVcsGitFileStatus' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Git summary: Post Git Changes description: Post the changes of a git repository operationId: post_git_changes parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Post_git_changesInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Git summary: Delete Git Changes description: Delete the changes of a git repository operationId: delete_git_changes parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/clone: post: tags: - Git summary: Clone Git description: Clone a git repository operationId: clone_git parameters: - name: id in: path description: The ID of the git repository to clone required: true schema: type: string description: The ID of the git repository to clone format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/commit: post: tags: - Git summary: Commit Git description: Commit a git repository operationId: commit_git parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Commit_gitInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/files: delete: tags: - Git summary: Delete Git File description: Delete a file of a git repository operationId: delete_git_file parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/files/copy: post: tags: - Git summary: Copy Git File description: Copy a file of a git repository operationId: copy_git_file parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Copy_git_fileInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/files/diff: get: tags: - Git summary: Get Git File Diff description: Get the diff of a file of a git repository operationId: get_git_file_diff parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid - name: path in: query description: The path of the file to diff required: true schema: type: string description: The path of the file to diff responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubEntityGitDiff' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/files/export: post: tags: - Git summary: Export Git description: Export a git repository operationId: export_git parameters: - name: id in: path description: The ID of the git repository to export required: true schema: type: string description: The ID of the git repository to export format: objectid responses: '200': description: OK '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/files/get: get: tags: - Git summary: Get Git File description: Get a file of a git repository operationId: get_git_file parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid - name: path in: query description: The path of the file to retrieve required: true schema: type: string description: The path of the file to retrieve responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseString' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/files/info: get: tags: - Git summary: Get Git File Info description: Get the info of a file of a git repository operationId: get_git_file_info parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid - name: path in: query description: The path of the file to get info for required: true schema: type: string description: The path of the file to get info for responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponse*GithubEntityFsFileInfo' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/files/list: get: tags: - Git summary: Get Git List Dir description: Get the list of a git repository operationId: get_git_list_dir parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid - name: path in: query description: The path to list contents of required: true schema: type: string description: The path to list contents of responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubEntityFsFileInfo' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/files/rename: post: tags: - Git summary: Rename Git File description: Rename a file of a git repository operationId: rename_git_file parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Rename_git_fileInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/files/save: post: tags: - Git summary: Save Git File description: Save a file of a git repository operationId: save_git_file parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Save_git_fileInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/files/save/dir: post: tags: - Git summary: Save Git Dir description: Save a directory of a git repository operationId: save_git_dir parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Save_git_dirInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/logs: get: tags: - Git summary: Get Git Logs description: Get the logs of a git repository operationId: get_git_logs parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubVcsGitLog' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/pull: post: tags: - Git summary: Pull Git description: Pull a git repository operationId: pull_git parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseString' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/push: post: tags: - Git summary: Push Git description: Push a git repository operationId: push_git parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseString' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /gits/{id}/spiders: post: tags: - Git summary: Create Git Spider description: Create a new spider of a git repository operationId: create_git_spider parameters: - name: id in: path description: The ID of the git repository required: true schema: type: string description: The ID of the git repository format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_git_spiderInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSpider' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /login: post: tags: - Auth summary: Login description: Login operationId: login requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseString' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /logout: post: tags: - Auth summary: Logout description: Logout operationId: logout responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /node-groups: get: tags: - Node Groups summary: Get Node Group List description: Get a list of node groups operationId: get_node_group_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsNodeGroup' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Node Groups summary: Create Node Group description: Create a new node group operationId: create_node_group requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_node_groupInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNodeGroup' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Node Groups summary: Delete Node Group List description: Delete a list of node groups operationId: delete_node_group_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /node-groups/{id}: get: tags: - Node Groups summary: Get Node Group by ID description: Get a node group by ID operationId: get_node_group_by_id parameters: - name: id in: path description: Node group ID required: true schema: type: string description: Node group ID responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNodeGroupDTO' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Node Groups summary: Update Node Group by ID description: Update a node group by ID operationId: update_node_group_by_id parameters: - name: id in: path description: Node group ID required: true schema: type: string description: Node group ID requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_node_group_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNodeGroup' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Node Groups summary: Delete Node Group by ID description: Delete a node group by ID operationId: delete_node_group_by_id parameters: - name: id in: path description: Node group ID required: true schema: type: string description: Node group ID responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /node-groups/{id}/nodes: post: tags: - Node Groups summary: Add Node to Group description: Add a node to a node group operationId: add_node_to_group parameters: - name: id in: path description: Node group ID required: true schema: type: string description: Node group ID requestBody: content: application/json: schema: $ref: '#/components/schemas/Add_node_to_groupInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /node-groups/{id}/nodes/{nodeId}: delete: tags: - Node Groups summary: Remove Node from Group description: Remove a node from a node group operationId: remove_node_from_group parameters: - name: id in: path description: Node group ID required: true schema: type: string description: Node group ID - name: nodeId in: path description: Node ID to remove required: true schema: type: string description: Node ID to remove responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /nodes: get: tags: - Nodes summary: Get Node List description: Get a list of nodes with their associated node groups operationId: get_node_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsNodeDTO' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Nodes summary: Create Node description: Create a new item operationId: create_node requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_nodeInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNode' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Nodes summary: Delete Node List description: Delete multiple nodes with deletion prevention checks operationId: delete_node_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNode' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Nodes summary: Batch Update Node List description: Batch update multiple items with partial fields operationId: batch_update_node_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_node_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNode' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /nodes/metrics: get: tags: - Nodes summary: Get Node Metrics description: Get the metrics of a node operationId: get_node_metrics parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseMapGoMongodbPrimitiveObjectID*GithubModelsMetric' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /nodes/{id}: get: tags: - Nodes summary: Get Node by ID description: Get a single node by ID with its associated node group operationId: get_node_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNodeDTO' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Nodes summary: Replace Node by ID description: Replace an item by ID with (full update) operationId: replace_node_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_node_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNode' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Nodes summary: Delete Node by ID description: Delete a single node by ID with deletion prevention checks operationId: delete_node_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNode' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Nodes summary: Update Node by ID description: Update an item by ID with (partial update) operationId: update_node_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_node_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNode' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /nodes/{id}/metrics/current: get: tags: - Nodes summary: Get Node Current Metrics by ID description: Get the current metrics of a node operationId: get_node_current_metrics_by_id parameters: - name: id in: path description: ID of the node required: true schema: type: string description: ID of the node format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsMetric' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /nodes/{id}/metrics/time-range: get: tags: - Nodes summary: Get Node Time Range Metrics by ID description: Get the time range metrics of a node operationId: get_node_time_range_metrics_by_id parameters: - name: id in: path description: ID of the node required: true schema: type: string description: ID of the node format: objectid - name: end in: query description: End time in RFC3339 format schema: type: string description: End time in RFC3339 format - name: metric_names in: query description: Comma-separated list of metric names required: true schema: type: string description: Comma-separated list of metric names - name: start in: query description: Start time in RFC3339 format required: true schema: type: string description: Start time in RFC3339 format - name: time_unit in: query description: Time unit for metrics aggregation required: true schema: type: string description: Time unit for metrics aggregation responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseMapStringInterface {}' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /notifications/alerts: get: tags: - Notification Alerts summary: Get Notifications Alert List description: Get a list of items operationId: get_notifications_alert_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsNotificationAlert' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Notification Alerts summary: Create Notifications Alert description: Create a new item operationId: create_notifications_alert requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_notifications_alertInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationAlert' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Notification Alerts summary: Delete Notifications Alert List description: Delete multiple items operationId: delete_notifications_alert_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationAlert' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Notification Alerts summary: Batch Update Notifications Alert List description: Batch update multiple items with partial fields operationId: batch_update_notifications_alert_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_notifications_alert_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationAlert' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /notifications/alerts/{id}: get: tags: - Notification Alerts summary: Get Notifications Alert by ID description: Get a single item by ID operationId: get_notifications_alert_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationAlert' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Notification Alerts summary: Replace Notifications Alert by ID description: Replace an item by ID with (full update) operationId: replace_notifications_alert_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_notifications_alert_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationAlert' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Notification Alerts summary: Delete Notifications Alert by ID description: Delete an item by ID operationId: delete_notifications_alert_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationAlert' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Notification Alerts summary: Update Notifications Alert by ID description: Update an item by ID with (partial update) operationId: update_notifications_alert_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_notifications_alert_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationAlert' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /notifications/channels: get: tags: - Notification Channels summary: Get Notifications Channel List description: Get a list of items operationId: get_notifications_channel_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsNotificationChannel' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Notification Channels summary: Create Notifications Channel description: Create a new item operationId: create_notifications_channel requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_notifications_channelInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationChannel' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Notification Channels summary: Delete Notifications Channel List description: Delete multiple items operationId: delete_notifications_channel_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationChannel' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Notification Channels summary: Batch Update Notifications Channel List description: Batch update multiple items with partial fields operationId: batch_update_notifications_channel_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_notifications_channel_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationChannel' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /notifications/channels/{id}: get: tags: - Notification Channels summary: Get Notifications Channel by ID description: Get a single item by ID operationId: get_notifications_channel_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationChannel' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Notification Channels summary: Replace Notifications Channel by ID description: Replace an item by ID with (full update) operationId: replace_notifications_channel_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_notifications_channel_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationChannel' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Notification Channels summary: Delete Notifications Channel by ID description: Delete an item by ID operationId: delete_notifications_channel_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationChannel' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Notification Channels summary: Update Notifications Channel by ID description: Update an item by ID with (partial update) operationId: update_notifications_channel_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_notifications_channel_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationChannel' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /notifications/channels/{id}/test: post: tags: - Notification Channels summary: Test Notification Channel description: Test a notification channel operationId: test_notification_channel parameters: - name: id in: path description: ID of the notification channel required: true schema: type: string description: ID of the notification channel format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Test_notification_channelInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /notifications/requests: get: tags: - Notification Requests summary: Get Notification Request List description: Get the list of a notification request operationId: get_notification_request_list parameters: - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: query in: query description: Filter query JSON string schema: type: string description: Filter query JSON string - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort option JSON string schema: type: string description: Sort option JSON string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsNotificationRequestDTO' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Notification Requests summary: Create Notifications Request description: Create a new item operationId: create_notifications_request requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_notifications_requestInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationRequest' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Notification Requests summary: Delete Notifications Request List description: Delete multiple items operationId: delete_notifications_request_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationRequest' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Notification Requests summary: Batch Update Notifications Request List description: Batch update multiple items with partial fields operationId: batch_update_notifications_request_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_notifications_request_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationRequest' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /notifications/requests/{id}: get: tags: - Notification Requests summary: Get Notifications Request by ID description: Get a single item by ID operationId: get_notifications_request_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationRequest' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Notification Requests summary: Replace Notifications Request by ID description: Replace an item by ID with (full update) operationId: replace_notifications_request_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_notifications_request_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationRequest' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Notification Requests summary: Delete Notifications Request by ID description: Delete an item by ID operationId: delete_notifications_request_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationRequest' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Notification Requests summary: Update Notifications Request by ID description: Update an item by ID with (partial update) operationId: update_notifications_request_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_notifications_request_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationRequest' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /notifications/settings: get: tags: - Notification Settings summary: Get Notification Setting List description: Get a list of notification settings operationId: get_notification_setting_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsNotificationSettingDTO' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Notification Settings summary: Create Notifications Setting description: Create a new item operationId: create_notifications_setting requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_notifications_settingInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationSetting' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Notification Settings summary: Delete Notifications Setting List description: Delete multiple items operationId: delete_notifications_setting_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationSetting' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Notification Settings summary: Batch Update Notifications Setting List description: Batch update multiple items with partial fields operationId: batch_update_notifications_setting_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_notifications_setting_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationSetting' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /notifications/settings/{id}: get: tags: - Notification Settings summary: Get Notification Setting by ID description: Get a notification setting by ID operationId: get_notification_setting_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationSettingDTO' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Notification Settings summary: Replace Notifications Setting by ID description: Replace an item by ID with (full update) operationId: replace_notifications_setting_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_notifications_setting_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationSetting' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Notification Settings summary: Delete Notifications Setting by ID description: Delete an item by ID operationId: delete_notifications_setting_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationSetting' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Notification Settings summary: Update Notifications Setting by ID description: Update an item by ID with (partial update) operationId: update_notifications_setting_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_notifications_setting_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsNotificationSetting' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /notifications/settings/{id}/disable: post: tags: - Notification Settings summary: Disable Notification Setting description: Disable a notification setting operationId: disable_notification_setting parameters: - name: id in: path description: ID of the notification setting required: true schema: type: string description: ID of the notification setting format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /notifications/settings/{id}/enable: post: tags: - Notification Settings summary: Enable Notification Setting description: Enable a notification setting operationId: enable_notification_setting parameters: - name: id in: path description: ID of the notification setting required: true schema: type: string description: ID of the notification setting format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /notifications/settings/{id}/requests: get: tags: - Notification Settings summary: Get Notification Setting Requests description: Get the requests of a notification setting operationId: get_notification_setting_requests parameters: - name: id in: path description: ID of the notification setting required: true schema: type: string description: ID of the notification setting format: objectid - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: query in: query description: Filter query JSON string schema: type: string description: Filter query JSON string - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort option JSON string schema: type: string description: Sort option JSON string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsNotificationRequest' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /projects: get: tags: - Projects summary: Get Project List description: Get a list of projects operationId: get_project_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsProjectDTO' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Projects summary: Create Project description: Create a new item operationId: create_project requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_projectInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsProject' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Projects summary: Delete Project List description: Delete multiple projects with deletion prevention checks operationId: delete_project_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsProject' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Projects summary: Batch Update Project List description: Batch update multiple items with partial fields operationId: batch_update_project_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_project_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsProject' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /projects/{id}: get: tags: - Projects summary: Get Project by ID description: Get a single item by ID operationId: get_project_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsProject' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Projects summary: Replace Project by ID description: Replace an item by ID with (full update) operationId: replace_project_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_project_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsProject' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Projects summary: Delete Project by ID description: Delete a single project by ID with deletion prevention checks operationId: delete_project_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsProject' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Projects summary: Update Project by ID description: Update an item by ID with (partial update) operationId: update_project_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_project_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsProject' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /roles: get: tags: - Roles summary: Get Role List description: Get a list of roles operationId: get_role_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsRole' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Roles summary: Create Role description: Create a new item operationId: create_role requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_roleInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsRole' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Roles summary: Delete Role List description: Delete a list of roles operationId: delete_role_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsRole' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Roles summary: Batch Update Role List description: Batch update multiple items with partial fields operationId: batch_update_role_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_role_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsRole' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /roles/{id}: get: tags: - Roles summary: Get Role by ID description: Get a role by ID operationId: get_role_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsRole' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Roles summary: Replace Role by ID description: Replace a role by ID (full update) operationId: replace_role_by_id parameters: - name: id in: path description: The ID of the role to update required: true schema: type: string description: The ID of the role to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_role_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsRole' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Roles summary: Delete Role by ID description: Delete a role by ID operationId: delete_role_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsRole' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Roles summary: Update Role by ID description: Update an item by ID with (partial update) operationId: update_role_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_role_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsRole' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /schedules: get: tags: - Schedules summary: Get Schedule List description: Get a list of schedules operationId: get_schedule_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsScheduleDTO' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Schedules summary: Create Schedule description: Create a new schedule operationId: create_schedule requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_scheduleInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSchedule' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Schedules summary: Delete Schedule List description: Delete multiple schedules with deletion prevention checks operationId: delete_schedule_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSchedule' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Schedules summary: Batch Update Schedule List description: Batch update multiple items with partial fields operationId: batch_update_schedule_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_schedule_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSchedule' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /schedules/{id}: get: tags: - Schedules summary: Get Schedule by ID description: Get a single schedule by ID operationId: get_schedule_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsScheduleDTO' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Schedules summary: Replace Schedule by ID description: Replace a schedule by ID (full update) operationId: replace_schedule_by_id parameters: - name: id in: path description: Schedule ID required: true schema: type: string description: Schedule ID format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_schedule_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSchedule' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Schedules summary: Delete Schedule by ID description: Delete a single schedule by ID with deletion prevention checks operationId: delete_schedule_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSchedule' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Schedules summary: Update Schedule by ID description: Update an item by ID with (partial update) operationId: update_schedule_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_schedule_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSchedule' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /schedules/{id}/disable: post: tags: - Schedules summary: Disable Schedule description: Disable a schedule operationId: disable_schedule parameters: - name: id in: path description: Schedule ID required: true schema: type: string description: Schedule ID format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /schedules/{id}/enable: post: tags: - Schedules summary: Enable Schedule description: Enable a schedule operationId: enable_schedule parameters: - name: id in: path description: Schedule ID required: true schema: type: string description: Schedule ID format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /schedules/{id}/run: post: tags: - Schedules summary: Run Schedule description: Run a schedule operationId: run_schedule parameters: - name: id in: path description: Schedule ID required: true schema: type: string description: Schedule ID format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Run_scheduleInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGoMongodbPrimitiveObjectID' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /settings/{key}: get: tags: - Settings summary: Get Setting description: Get a setting operationId: get_setting parameters: - name: key in: path description: Setting key required: true schema: type: string description: Setting key responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSetting' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Settings summary: Replace Setting by Type description: Replace a setting by key (full update) operationId: replace_setting_by_type parameters: - name: key in: path description: Setting key required: true schema: type: string description: Setting key requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_setting_by_typeInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSetting' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Settings summary: Create Setting description: Create a new setting operationId: create_setting parameters: - name: key in: path description: Setting key required: true schema: type: string description: Setting key requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_settingInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSetting' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /spiders: get: tags: - Spiders summary: Get Spider List description: Get a list of spiders operationId: get_spider_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsSpiderDTO' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Spiders summary: Create Spider description: Create a new spider operationId: create_spider requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_spiderInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSpider' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Spiders summary: Delete Spider List description: Delete a list of spiders operationId: delete_spider_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSpider' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Spiders summary: Batch Update Spider List description: Batch update multiple items with partial fields operationId: batch_update_spider_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_spider_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSpider' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /spiders/{id}: get: tags: - Spiders summary: Get Spider by ID description: Get a single spider by ID operationId: get_spider_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSpiderDTO' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Spiders summary: Replace Spider by ID description: Replace an item by ID with (full update) operationId: replace_spider_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_spider_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSpider' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Spiders summary: Delete Spider by ID description: Delete a spider by ID operationId: delete_spider_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSpider' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Spiders summary: Update Spider by ID description: Update an item by ID with (partial update) operationId: update_spider_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_spider_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsSpider' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /spiders/{id}/files: delete: tags: - Spiders summary: Delete Spider File description: Delete a spider file operationId: delete_spider_file parameters: - name: id in: path description: Spider ID required: true schema: type: string description: Spider ID format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /spiders/{id}/files/copy: post: tags: - Spiders summary: Copy Spider File description: Copy a spider file operationId: copy_spider_file parameters: - name: id in: path description: Spider ID required: true schema: type: string description: Spider ID format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Copy_spider_fileInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /spiders/{id}/files/export: post: tags: - Spiders summary: Export Spider Files description: Export spider files to a zip file operationId: export_spider_files parameters: - name: id in: path description: Spider ID required: true schema: type: string description: Spider ID format: objectid responses: '200': description: OK '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /spiders/{id}/files/get: get: tags: - Spiders summary: Get Spider File Content description: Get the content of a spider file operationId: get_spider_file_content parameters: - name: id in: path description: Spider ID required: true schema: type: string description: Spider ID format: objectid - name: path in: query description: File path schema: type: string description: File path responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseString' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /spiders/{id}/files/info: get: tags: - Spiders summary: Get Spider File Info description: Get the info of a spider file operationId: get_spider_file_info parameters: - name: id in: path description: Spider ID required: true schema: type: string description: Spider ID format: objectid - name: path in: query description: File path schema: type: string description: File path responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponse*GithubEntityFsFileInfo' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /spiders/{id}/files/list: get: tags: - Spiders summary: List Spider Files description: List the files given a directory path in the spider project operationId: list_spider_files parameters: - name: id in: path description: Spider ID required: true schema: type: string description: Spider ID format: objectid - name: path in: query description: Directory path schema: type: string description: Directory path responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubEntityFsFileInfo' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /spiders/{id}/files/rename: post: tags: - Spiders summary: Rename Spider File description: Rename a spider file operationId: rename_spider_file parameters: - name: id in: path description: Spider ID required: true schema: type: string description: Spider ID format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Rename_spider_fileInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /spiders/{id}/files/save: post: tags: - Spiders summary: Save Spider File description: Save a spider file operationId: save_spider_file parameters: - name: id in: path description: Spider ID required: true schema: type: string description: Spider ID format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Save_spider_fileInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /spiders/{id}/files/save/dir: post: tags: - Spiders summary: Save Spider Dir description: Save a spider directory operationId: save_spider_dir parameters: - name: id in: path description: Spider ID required: true schema: type: string description: Spider ID format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Save_spider_dirInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /spiders/{id}/results: get: tags: - Spiders summary: Get Spider Results description: Get the scraped or crawled results data of a spider operationId: get_spider_results parameters: - name: id in: path description: Spider ID required: true schema: type: string description: Spider ID format: objectid - name: page in: query description: Page schema: type: integer description: Page format: int32 default: 1 - name: size in: query description: Size schema: type: integer description: Size format: int32 default: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGoMongodbPrimitiveM' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /spiders/{id}/run: post: tags: - Spiders summary: Run Spider description: Run a task for the given spider operationId: run_spider parameters: - name: id in: path description: Spider ID required: true schema: type: string description: Spider ID format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Run_spiderInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGoMongodbPrimitiveObjectID' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /stats/daily: get: tags: - Stats summary: Get Stats Daily description: Get the daily stats operationId: get_stats_daily responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubEntityStatsDailyItem' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /stats/overview: get: tags: - Stats summary: Get Stats Overview description: Get the overview of the stats operationId: get_stats_overview responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubControllersGetStatsOverviewResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /stats/tasks: get: tags: - Stats summary: Get Stats Tasks description: Get the tasks stats operationId: get_stats_tasks responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubControllersGetStatsTaskResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /sync/{id}/download: get: tags: - Sync summary: Download file (sync) description: Download a file for a specific ID (Spider/Git) operationId: download_file_(sync) responses: '200': description: OK '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /sync/{id}/scan: get: tags: - Sync summary: Scan files (sync) description: Scan files for a specific ID (Spider/Git) operationId: scan_files_(sync) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubEntityFsFileInfoMap' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /system-info: get: tags: - System summary: Get System Info description: Get the system info operationId: get_system_info responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubEntitySystemInfo' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /tasks: get: tags: - Tasks summary: Get Task List description: Get a list of tasks (default sorted in descending order) operationId: get_task_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsTaskDTO' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Tasks summary: Create Task description: Create a new item operationId: create_task requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_taskInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsTask' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Tasks summary: Delete Task List description: Delete a list of tasks operationId: delete_task_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Tasks summary: Batch Update Task List description: Batch update multiple items with partial fields operationId: batch_update_task_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_task_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsTask' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /tasks/run: post: tags: - Tasks summary: Run Task description: Run a task operationId: run_task requestBody: content: application/json: schema: $ref: '#/components/schemas/Run_taskInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGoMongodbPrimitiveObjectID' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /tasks/{id}: get: tags: - Tasks summary: Get Task by ID description: Get a single task by ID operationId: get_task_by_id parameters: - name: id in: path description: Task ID required: true schema: type: string description: Task ID format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsTaskDTO' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Tasks summary: Replace Task by ID description: Replace an item by ID with (full update) operationId: replace_task_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_task_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsTask' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Tasks summary: Delete Task by ID description: Delete a task by ID operationId: delete_task_by_id parameters: - name: id in: path description: Task ID required: true schema: type: string description: Task ID format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Tasks summary: Update Task by ID description: Update an item by ID with (partial update) operationId: update_task_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_task_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsTask' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /tasks/{id}/cancel: post: tags: - Tasks summary: Cancel Task description: Cancel a task operationId: cancel_task parameters: - name: id in: path description: Task ID required: true schema: type: string description: Task ID format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Cancel_taskInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersVoidResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /tasks/{id}/logs: get: tags: - Tasks summary: Get Task Logs description: Get the logs of a task operationId: get_task_logs parameters: - name: id in: path description: Task ID required: true schema: type: string description: Task ID format: objectid - name: latest in: query description: 'Whether to get latest logs (default: true)' allowEmptyValue: true schema: type: boolean description: 'Whether to get latest logs (default: true)' default: true - name: page in: query description: 'Page (default: 1)' schema: type: integer description: 'Page (default: 1)' format: int32 default: 1 - name: size in: query description: 'Size (default: 10000)' schema: type: integer description: 'Size (default: 10000)' format: int32 default: 10000 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseString' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /tasks/{id}/restart: post: tags: - Tasks summary: Restart Task description: Restart a task operationId: restart_task parameters: - name: id in: path description: Task ID required: true schema: type: string description: Task ID format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGoMongodbPrimitiveObjectID' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /tasks/{id}/results: get: tags: - Tasks summary: Get Task Results description: Get the scraped or crawled results data of a task operationId: get_task_results parameters: - name: id in: path description: Spider ID required: true schema: type: string description: Spider ID format: objectid - name: page in: query description: Page schema: type: integer description: Page format: int32 default: 1 - name: size in: query description: Size schema: type: integer description: Size format: int32 default: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGoMongodbPrimitiveM' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /tokens: get: tags: - Tokens summary: Get Token List description: Get a list of tokens operationId: get_token_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsToken' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Tokens summary: Create Token description: Create a new token operationId: create_token requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_tokenInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsToken' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Tokens summary: Delete Token List description: Delete multiple items operationId: delete_token_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsToken' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Tokens summary: Batch Update Token List description: Batch update multiple items with partial fields operationId: batch_update_token_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_token_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsToken' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /tokens/{id}: get: tags: - Tokens summary: Get Token by ID description: Get a single item by ID operationId: get_token_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsToken' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Tokens summary: Replace Token by ID description: Replace an item by ID with (full update) operationId: replace_token_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_token_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsToken' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Tokens summary: Delete Token by ID description: Delete an item by ID operationId: delete_token_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsToken' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Tokens summary: Update Token by ID description: Update an item by ID with (partial update) operationId: update_token_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_token_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsToken' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /users: get: tags: - Users summary: Get User List description: Get a list of users operationId: get_user_list parameters: - name: filter in: query description: Filter query schema: type: string description: Filter query - name: page in: query description: Page number schema: type: integer description: Page number format: int32 default: 1 - name: size in: query description: Page size schema: type: integer description: Page size format: int32 default: 10 - name: sort in: query description: Sort options schema: type: string description: Sort options default: -_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersListResponseGithubModelsUser' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error post: tags: - Users summary: Create User description: Create a new user operationId: create_user requestBody: content: application/json: schema: $ref: '#/components/schemas/Create_userInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsUser' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Users summary: Delete User List description: Delete a list of users operationId: delete_user_list responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsUser' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Users summary: Batch Update User List description: Batch update multiple items with partial fields operationId: batch_update_user_list requestBody: content: application/json: schema: $ref: '#/components/schemas/Batch_update_user_listInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsUser' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /users/me: get: tags: - Users summary: Get Me description: Get the current user operationId: get_me responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsUser' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Users summary: Replace Me description: Update the current user (full update) operationId: replace_me requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_meInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsUser' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /users/me/change-password: post: tags: - Users summary: Change My Password description: Change the current user's password operationId: change_my_password requestBody: content: application/json: schema: $ref: '#/components/schemas/Change_my_passwordInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsUser' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /users/{id}: get: tags: - Users summary: Get User by ID description: Get a single user by ID operationId: get_user_by_id parameters: - name: id in: path description: The ID of the item to get required: true schema: type: string description: The ID of the item to get format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsUser' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error put: tags: - Users summary: Replace User by ID description: Replace a user by ID (full update) operationId: replace_user_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Replace_user_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsUser' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error delete: tags: - Users summary: Delete User by ID description: Delete a user by ID operationId: delete_user_by_id parameters: - name: id in: path description: The ID of the item to delete required: true schema: type: string description: The ID of the item to delete format: objectid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsUser' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error patch: tags: - Users summary: Update User by ID description: Update an item by ID with (partial update) operationId: update_user_by_id parameters: - name: id in: path description: The ID of the item to update required: true schema: type: string description: The ID of the item to update format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Update_user_by_idInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsUser' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error /users/{id}/change-password: post: tags: - Users summary: Change User Password description: Change a user's password operationId: change_user_password parameters: - name: id in: path description: User ID required: true schema: type: string description: User ID format: objectid requestBody: content: application/json: schema: $ref: '#/components/schemas/Change_user_passwordInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ControllersResponseGithubModelsUser' '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error components: schemas: Add_node_to_groupInput: type: object properties: node_id: type: string description: Node ID to add required: - node_id Batch_update_conversation_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_data_collection_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_database_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_dependencies_setting_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_environment_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_git_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_llm_provider_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_node_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_notifications_alert_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_notifications_channel_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_notifications_request_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_notifications_setting_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_project_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_role_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_schedule_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_spider_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_task_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_token_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Batch_update_user_listInput: type: object properties: ids: type: array items: type: string description: The IDs of the items to update update: type: object additionalProperties: {} description: The update object required: - ids - update Cancel_taskInput: type: object properties: force: type: boolean description: Force cancel default: false Change_my_passwordInput: type: object properties: password: type: string description: Password required: - password Change_user_passwordInput: type: object properties: password: type: string description: Password required: - password Checkout_git_branchInput: type: object properties: branch: type: string description: The branch to checkout required: - branch Checkout_git_remote_branchInput: type: object properties: branch: type: string description: The remote branch to checkout required: - branch Commit_gitInput: type: object properties: changes: type: array items: $ref: '#/components/schemas/VcsGitFileStatus' description: The changes to commit message: type: string description: The commit message required: - changes - message ControllersDatabaseOrmCompatibilityResponse: type: object properties: compatible: type: boolean description: Whether the database is compatible with ORM data_source: type: string description: Database data source type reasons: type: array items: type: string description: Reasons for incompatibility (if any) should_show_toggle: type: boolean description: Whether to show ORM toggle in UI supported_sources: type: array items: type: string description: List of all ORM-supported data sources ControllersDatabaseOrmStatusResponse: type: object properties: enabled: type: boolean description: Whether ORM is enabled supported: type: boolean description: Whether ORM is supported for this database type ControllersGetDatabaseMetricsResponse: type: object ControllersGetDependencySpiderDependencyListResponse: type: object properties: file_type: type: string description: The file type of the spider lang: type: string description: The programming language of the spider requirements: type: array items: $ref: '#/components/schemas/EntityDependencyRequirement' description: The dependency requirements of the spider ControllersGetStatsOverviewResponse: type: object properties: error_tasks: type: integer description: Number of error tasks format: int32 nodes: type: integer description: Number of nodes format: int32 projects: type: integer description: Number of projects format: int32 results: type: integer description: Number of results format: int32 schedules: type: integer description: Number of schedules format: int32 spiders: type: integer description: Number of spiders format: int32 tasks: type: integer description: Number of tasks format: int32 users: type: integer description: Number of users format: int32 ControllersGetStatsTaskResponse: type: object properties: by_node: type: array items: $ref: '#/components/schemas/ControllersGetStatsTaskResponseByNodeItem' by_spider: type: array items: $ref: '#/components/schemas/ControllersGetStatsTaskResponseBySpiderItem' by_status: type: array items: $ref: '#/components/schemas/ControllersGetStatsTaskResponseByStatusItem' ControllersGetStatsTaskResponseByNodeItem: type: object properties: node: $ref: '#/components/schemas/ModelsNode' node_id: type: string format: objectid node_name: type: string tasks: type: integer format: int32 ControllersGetStatsTaskResponseBySpiderItem: type: object properties: spider: $ref: '#/components/schemas/ModelsSpider' spider_id: type: string format: objectid spider_name: type: string tasks: type: integer format: int32 ControllersGetStatsTaskResponseByStatusItem: type: object properties: status: type: string tasks: type: integer format: int32 ControllersListResponseGithubEntityDependencyRepo: type: object properties: data: type: array items: $ref: '#/components/schemas/EntityDependencyRepo' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsChatConversation: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsChatConversation' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsDataCollection: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsDataCollection' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsDatabase: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsDatabase' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsDependencyConfig: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsDependencyConfig' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsEnvironment: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsEnvironment' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsGitDTO: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsGitDTO' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsLLMProvider: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsLLMProvider' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsNodeDTO: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsNodeDTO' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsNodeGroup: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsNodeGroup' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsNotificationAlert: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsNotificationAlert' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsNotificationChannel: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsNotificationChannel' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsNotificationRequest: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsNotificationRequest' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsNotificationRequestDTO: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsNotificationRequestDTO' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsNotificationSettingDTO: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsNotificationSettingDTO' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsProjectDTO: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsProjectDTO' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsRole: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsRole' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsScheduleDTO: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsScheduleDTO' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsSpiderDTO: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsSpiderDTO' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsTaskDTO: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsTaskDTO' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsToken: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsToken' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGithubModelsUser: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsUser' error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseGoMongodbPrimitiveM: type: object properties: data: type: array items: type: object additionalProperties: {} error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseMapStringInterface {}: type: object properties: data: type: array items: type: object additionalProperties: {} error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersListResponseString: type: object properties: data: type: array items: type: string error: type: string message: type: string status: type: string total: type: integer format: int32 ControllersPutDatabaseOrmStatusRequestBody: type: object properties: enabled: type: boolean description: Whether to enable ORM description: ORM status update data required: - enabled ControllersResponse*GithubEntityDatabaseQueryResults: type: object properties: data: $ref: '#/components/schemas/EntityDatabaseQueryResults' error: type: string message: type: string status: type: string ControllersResponse*GithubEntityDatabaseTable: type: object properties: data: $ref: '#/components/schemas/EntityDatabaseTable' error: type: string message: type: string status: type: string ControllersResponse*GithubEntityFsFileInfo: type: object properties: data: $ref: '#/components/schemas/EntityFsFileInfo' error: type: string message: type: string status: type: string ControllersResponse*GithubModelsDatabaseMetric: type: object properties: data: $ref: '#/components/schemas/ModelsDatabaseMetric' error: type: string message: type: string status: type: string ControllersResponseGithubControllersDatabaseOrmCompatibilityResponse: type: object properties: data: $ref: '#/components/schemas/ControllersDatabaseOrmCompatibilityResponse' error: type: string message: type: string status: type: string ControllersResponseGithubControllersDatabaseOrmStatusResponse: type: object properties: data: $ref: '#/components/schemas/ControllersDatabaseOrmStatusResponse' error: type: string message: type: string status: type: string ControllersResponseGithubControllersGetDatabaseMetricsResponse: type: object properties: data: $ref: '#/components/schemas/ControllersGetDatabaseMetricsResponse' error: type: string message: type: string status: type: string ControllersResponseGithubControllersGetDependencySpiderDependencyListResponse: type: object properties: data: $ref: '#/components/schemas/ControllersGetDependencySpiderDependencyListResponse' error: type: string message: type: string status: type: string ControllersResponseGithubControllersGetStatsOverviewResponse: type: object properties: data: $ref: '#/components/schemas/ControllersGetStatsOverviewResponse' error: type: string message: type: string status: type: string ControllersResponseGithubControllersGetStatsTaskResponse: type: object properties: data: $ref: '#/components/schemas/ControllersGetStatsTaskResponse' error: type: string message: type: string status: type: string ControllersResponseGithubEntityDatabaseMetadata: type: object properties: data: $ref: '#/components/schemas/EntityDatabaseMetadata' error: type: string message: type: string status: type: string ControllersResponseGithubEntityFilterSelectOption: type: object properties: data: type: array items: $ref: '#/components/schemas/EntityFilterSelectOption' error: type: string message: type: string status: type: string ControllersResponseGithubEntityFsFileInfo: type: object properties: data: type: array items: $ref: '#/components/schemas/EntityFsFileInfo' error: type: string message: type: string status: type: string ControllersResponseGithubEntityFsFileInfoMap: type: object properties: data: type: object additionalProperties: $ref: '#/components/schemas/EntityFsFileInfo' error: type: string message: type: string status: type: string ControllersResponseGithubEntityGitDiff: type: object properties: data: $ref: '#/components/schemas/EntityGitDiff' error: type: string message: type: string status: type: string ControllersResponseGithubEntityStatsDailyItem: type: object properties: data: type: array items: $ref: '#/components/schemas/EntityStatsDailyItem' error: type: string message: type: string status: type: string ControllersResponseGithubEntitySystemInfo: type: object properties: data: $ref: '#/components/schemas/EntitySystemInfo' error: type: string message: type: string status: type: string ControllersResponseGithubInterfacesExport: type: object properties: error: type: string message: type: string status: type: string ControllersResponseGithubModelsChatConversation: type: object properties: data: $ref: '#/components/schemas/ModelsChatConversation' error: type: string message: type: string status: type: string ControllersResponseGithubModelsChatMessage: type: object properties: data: $ref: '#/components/schemas/ModelsChatMessage' error: type: string message: type: string status: type: string ControllersResponseGithubModelsDataCollection: type: object properties: data: $ref: '#/components/schemas/ModelsDataCollection' error: type: string message: type: string status: type: string ControllersResponseGithubModelsDatabase: type: object properties: data: $ref: '#/components/schemas/ModelsDatabase' error: type: string message: type: string status: type: string ControllersResponseGithubModelsDependencyConfig: type: object properties: data: $ref: '#/components/schemas/ModelsDependencyConfig' error: type: string message: type: string status: type: string ControllersResponseGithubModelsDependencyConfigSetup: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsDependencyConfigSetup' error: type: string message: type: string status: type: string ControllersResponseGithubModelsDependencyLog: type: object properties: data: type: array items: $ref: '#/components/schemas/ModelsDependencyLog' error: type: string message: type: string status: type: string ControllersResponseGithubModelsEnvironment: type: object properties: data: $ref: '#/components/schemas/ModelsEnvironment' error: type: string message: type: string status: type: string ControllersResponseGithubModelsGit: type: object properties: data: $ref: '#/components/schemas/ModelsGit' error: type: string message: type: string status: type: string ControllersResponseGithubModelsGitDTO: type: object properties: data: $ref: '#/components/schemas/ModelsGitDTO' error: type: string message: type: string status: type: string ControllersResponseGithubModelsLLMProvider: type: object properties: data: $ref: '#/components/schemas/ModelsLLMProvider' error: type: string message: type: string status: type: string ControllersResponseGithubModelsMetric: type: object properties: data: $ref: '#/components/schemas/ModelsMetric' error: type: string message: type: string status: type: string ControllersResponseGithubModelsNode: type: object properties: data: $ref: '#/components/schemas/ModelsNode' error: type: string message: type: string status: type: string ControllersResponseGithubModelsNodeDTO: type: object properties: data: $ref: '#/components/schemas/ModelsNodeDTO' error: type: string message: type: string status: type: string ControllersResponseGithubModelsNodeGroup: type: object properties: data: $ref: '#/components/schemas/ModelsNodeGroup' error: type: string message: type: string status: type: string ControllersResponseGithubModelsNodeGroupDTO: type: object properties: data: $ref: '#/components/schemas/ModelsNodeGroupDTO' error: type: string message: type: string status: type: string ControllersResponseGithubModelsNotificationAlert: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationAlert' error: type: string message: type: string status: type: string ControllersResponseGithubModelsNotificationChannel: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationChannel' error: type: string message: type: string status: type: string ControllersResponseGithubModelsNotificationRequest: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationRequest' error: type: string message: type: string status: type: string ControllersResponseGithubModelsNotificationSetting: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationSetting' error: type: string message: type: string status: type: string ControllersResponseGithubModelsNotificationSettingDTO: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationSettingDTO' error: type: string message: type: string status: type: string ControllersResponseGithubModelsProject: type: object properties: data: $ref: '#/components/schemas/ModelsProject' error: type: string message: type: string status: type: string ControllersResponseGithubModelsRole: type: object properties: data: $ref: '#/components/schemas/ModelsRole' error: type: string message: type: string status: type: string ControllersResponseGithubModelsSchedule: type: object properties: data: $ref: '#/components/schemas/ModelsSchedule' error: type: string message: type: string status: type: string ControllersResponseGithubModelsScheduleDTO: type: object properties: data: $ref: '#/components/schemas/ModelsScheduleDTO' error: type: string message: type: string status: type: string ControllersResponseGithubModelsSetting: type: object properties: data: $ref: '#/components/schemas/ModelsSetting' error: type: string message: type: string status: type: string ControllersResponseGithubModelsSpider: type: object properties: data: $ref: '#/components/schemas/ModelsSpider' error: type: string message: type: string status: type: string ControllersResponseGithubModelsSpiderDTO: type: object properties: data: $ref: '#/components/schemas/ModelsSpiderDTO' error: type: string message: type: string status: type: string ControllersResponseGithubModelsTask: type: object properties: data: $ref: '#/components/schemas/ModelsTask' error: type: string message: type: string status: type: string ControllersResponseGithubModelsTaskDTO: type: object properties: data: $ref: '#/components/schemas/ModelsTaskDTO' error: type: string message: type: string status: type: string ControllersResponseGithubModelsToken: type: object properties: data: $ref: '#/components/schemas/ModelsToken' error: type: string message: type: string status: type: string ControllersResponseGithubModelsUser: type: object properties: data: $ref: '#/components/schemas/ModelsUser' error: type: string message: type: string status: type: string ControllersResponseGithubVcsGitFileStatus: type: object properties: data: type: array items: $ref: '#/components/schemas/VcsGitFileStatus' error: type: string message: type: string status: type: string ControllersResponseGithubVcsGitLog: type: object properties: data: type: array items: $ref: '#/components/schemas/VcsGitLog' error: type: string message: type: string status: type: string ControllersResponseGithubVcsGitRef: type: object properties: data: $ref: '#/components/schemas/VcsGitRef' error: type: string message: type: string status: type: string ControllersResponseGoMongodbPrimitiveObjectID: type: object properties: data: type: array items: type: string format: objectid error: type: string message: type: string status: type: string ControllersResponseMapGoMongodbPrimitiveObjectID*GithubModelsMetric: type: object properties: error: type: string message: type: string status: type: string ControllersResponseMapStringInterface {}: type: object properties: data: type: array items: type: object additionalProperties: {} error: type: string message: type: string status: type: string ControllersResponseString: type: object properties: data: type: array items: type: string error: type: string message: type: string status: type: string ControllersTableDataRow: type: object properties: filter: type: object additionalProperties: {} description: Filter for finding rows to update or delete row: type: object additionalProperties: {} description: Data for new row status: type: string description: Operation status (new, updated, deleted) update: type: object additionalProperties: {} description: Update data for rows ControllersVoidResponse: type: object properties: error: type: string message: type: string status: type: string Copy_git_fileInput: type: object properties: new_path: type: string description: The destination path for the copy path: type: string description: The path of the file to copy required: - new_path - path Copy_spider_fileInput: type: object properties: new_path: type: string description: New file path path: type: string description: File path to copy Create_conversationInput: type: object properties: data: $ref: '#/components/schemas/ModelsChatConversation' required: - data Create_data_collectionInput: type: object properties: data: $ref: '#/components/schemas/ModelsDataCollection' required: - data Create_databaseInput: type: object properties: data: $ref: '#/components/schemas/ModelsDatabase' required: - data Create_database_tableInput: type: object properties: database_name: type: string description: Name of the database table: $ref: '#/components/schemas/EntityDatabaseTable' Create_database_table_dataInput: type: object properties: database_name: type: string description: Name of the database rows: type: array items: $ref: '#/components/schemas/ControllersTableDataRow' description: Rows to create, update, or delete minItems: 1 table_name: type: string description: Name of the table required: - rows - table_name Create_dependencies_settingInput: type: object properties: data: $ref: '#/components/schemas/ModelsDependencyConfig' required: - data Create_environmentInput: type: object properties: data: $ref: '#/components/schemas/ModelsEnvironment' required: - data Create_gitInput: type: object properties: data: $ref: '#/components/schemas/ModelsGit' required: - data Create_git_new_branchInput: type: object properties: source_branch: type: string description: The source branch to create from target_branch: type: string description: The target branch to create required: - source_branch - target_branch Create_git_spiderInput: type: object properties: data: $ref: '#/components/schemas/ModelsSpider' required: - data Create_nodeInput: type: object properties: data: $ref: '#/components/schemas/ModelsNode' required: - data Create_node_groupInput: type: object properties: data: $ref: '#/components/schemas/ModelsNodeGroup' required: - data Create_notifications_alertInput: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationAlert' required: - data Create_notifications_channelInput: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationChannel' required: - data Create_notifications_requestInput: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationRequest' required: - data Create_notifications_settingInput: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationSetting' required: - data Create_projectInput: type: object properties: data: $ref: '#/components/schemas/ModelsProject' required: - data Create_roleInput: type: object properties: data: $ref: '#/components/schemas/ModelsRole' required: - data Create_scheduleInput: type: object properties: data: $ref: '#/components/schemas/ModelsSchedule' required: - data Create_settingInput: type: object properties: data: $ref: '#/components/schemas/ModelsSetting' required: - data Create_spiderInput: type: object properties: data: $ref: '#/components/schemas/ModelsSpider' required: - data Create_taskInput: type: object properties: data: $ref: '#/components/schemas/ModelsTask' required: - data Create_tokenInput: type: object properties: data: $ref: '#/components/schemas/ModelsToken' required: - data Create_userInput: type: object properties: data: type: object properties: email: type: string description: Email password: type: string description: Password role: type: string description: Role role_id: type: string description: Role ID format: objectid username: type: string description: Username required: - password - username required: - data EntityDataField: type: object properties: key: type: string type: type: string EntityDatabase: type: object properties: name: type: string tables: type: array items: $ref: '#/components/schemas/EntityDatabaseTable' EntityDatabaseColumn: type: object properties: auto_increment: type: boolean children: type: array items: $ref: '#/components/schemas/EntityDatabaseColumn' default: type: string extra: type: string hash: type: string key: type: string name: type: string not_null: type: boolean original_name: type: string primary: type: boolean status: type: string type: type: string EntityDatabaseIndex: type: object properties: columns: type: array items: $ref: '#/components/schemas/EntityDatabaseIndexColumn' hash: type: string name: type: string original_name: type: string status: type: string type: type: string unique: type: boolean EntityDatabaseIndexColumn: type: object properties: name: type: string order: type: integer format: int32 EntityDatabaseMetadata: type: object properties: databases: type: array items: $ref: '#/components/schemas/EntityDatabase' EntityDatabaseQueryResults: type: object properties: columns: type: array items: $ref: '#/components/schemas/EntityDatabaseColumn' error: type: string output: type: string rows: type: array items: type: object additionalProperties: {} EntityDatabaseTable: type: object properties: columns: type: array items: $ref: '#/components/schemas/EntityDatabaseColumn' indexes: type: array items: $ref: '#/components/schemas/EntityDatabaseIndex' name: type: string description: Updated table definition EntityDependencyRepo: type: object properties: dependencies: type: array items: $ref: '#/components/schemas/ModelsDependency' latest_version: type: string name: type: string node_ids: type: array items: type: string format: objectid type: type: string versions: type: array items: type: string EntityDependencyRequirement: type: object properties: dependencies: type: array items: $ref: '#/components/schemas/ModelsDependency' latest_version: type: string name: type: string type: type: string version: type: string EntityFilterSelectOption: type: object properties: label: type: string value: description: Value of any type, including null nullable: true EntityFsFileInfo: type: object properties: children: type: array items: $ref: '#/components/schemas/EntityFsFileInfo' extension: type: string file_size: type: integer format: int64 full_path: type: string hash: type: string is_dir: type: boolean mod_time: type: string format: date-time mode: type: integer format: int32 name: type: string path: type: string EntityGitDiff: type: object properties: current_content: type: string parent_content: type: string EntityLLMResponseUsage: type: object properties: completion_tokens: type: integer format: int32 prompt_tokens: type: integer format: int32 total_tokens: type: integer format: int32 description: Usage EntityStatsDailyItem: type: object properties: date: type: string results: type: integer format: int64 tasks: type: integer format: int64 EntitySystemInfo: type: object properties: edition: type: string version: type: string Get_database_table_data_with_filterInput: type: object properties: database: type: string description: Name of the database filter: type: object additionalProperties: {} description: Filter criteria for the table data page: type: integer description: Page number format: int32 default: 1 size: type: integer description: Page size format: int32 default: 10 table: type: string description: Name of the table required: - table Get_database_table_metadata_with_filterInput: type: object properties: database: type: string description: Name of the database filter: type: object additionalProperties: {} description: Filter criteria for the table metadata table: type: string description: Name of the table required: - table Install_dependencyInput: type: object properties: lang: type: string description: The programming language of the dependency mode: type: string description: Installation mode ('all' or specific nodes) name: type: string description: The name of the dependency to install node_ids: type: array items: type: string format: objectid description: The IDs of nodes to install on (only used when mode is not 'all') version: type: string description: The version of the dependency to install Install_dependency_config_setupInput: type: object properties: mode: type: string description: Installation mode ('all' or specific nodes) node_ids: type: array items: type: string format: objectid description: The IDs of nodes to install on (only used when mode is not 'all') version: type: string description: The version to install LoginInput: type: object properties: password: type: string description: Password username: type: string description: Username required: - password - username ModelsChatConversation: type: object properties: _id: type: string description: ID format: objectid created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid description: type: string description: Conversation description last_message_at: type: integer description: Last message timestamp format: int64 messages: type: array items: $ref: '#/components/schemas/ModelsChatMessage' description: Messages in this conversation (populated field) model: type: string description: Default AI model for this conversation settings: type: object additionalProperties: {} description: Conversation settings status: type: string description: Conversation status (active/archived/deleted) tags: type: array items: type: string description: Conversation tags title: type: string description: Conversation title updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid user_id: type: string description: User ID who owns this conversation format: objectid description: The data to update ModelsChatMessage: type: object properties: _id: type: string description: ID format: objectid content: type: string description: Message content for user/system only content_ids: type: array items: type: string format: objectid description: Content IDs contents: type: array items: $ref: '#/components/schemas/ModelsChatMessageContent' description: Contents conversation_id: type: string description: Conversation ID format: objectid created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid error: type: string description: Error message if failed is_agent: type: boolean description: Is agent model: type: string description: AI model used role: type: string description: Message role (user/assistant/system) status: type: string description: Message status (pending/completed/failed) updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid usage: $ref: '#/components/schemas/EntityLLMResponseUsage' ModelsChatMessageContent: type: object properties: _id: type: string description: ID format: objectid action: type: string description: Action name action_status: type: string description: Action status action_target: type: string description: Action target content: type: string description: Message content created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid hidden: type: boolean description: Hidden key: type: string description: Message content key message_id: type: string description: Message ID format: objectid parameters: type: object additionalProperties: {} description: Message content parameters type: type: string description: Message type (text/action) updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid usage: $ref: '#/components/schemas/EntityLLMResponseUsage' ModelsDataCollection: type: object properties: _id: type: string description: ID format: objectid created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid dedup: type: object properties: enabled: type: boolean keys: type: array items: type: string type: type: string fields: type: array items: $ref: '#/components/schemas/EntityDataField' name: type: string updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid description: The data to update ModelsDatabase: type: object properties: _id: type: string description: ID format: objectid active: type: boolean description: Active active_ts: type: string description: Active at format: date-time cassandra_params: type: object properties: keyspace: type: string description: Keyspace description: Cassandra params created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid data_source: type: string description: Data source database: type: string description: Database description: type: string description: Description error: type: string description: Error hive_params: type: object properties: auth: type: string description: Auth description: Hive params host: type: string description: Host is_default: type: boolean mongo_params: type: object properties: auth_mechanism: type: string description: Auth mechanism auth_source: type: string description: Auth source description: Mongo params name: type: string description: Name password: type: string port: type: integer description: Port format: int32 postgres_params: type: object properties: ssl_mode: type: string description: SSL mode description: Postgres params redis_params: type: object properties: db: type: integer description: DB format: int32 description: Redis params snowflake_params: type: object properties: account: type: string description: Account role: type: string description: Role schema: type: string description: Schema warehouse: type: string description: Warehouse description: Snowflake params status: type: string description: Status updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid uri: type: string description: URI use_orm: type: boolean description: Use ORM instead of legacy database service (only for MySQL, PostgreSQL, SQL Server) username: type: string description: Username description: The data to update ModelsDatabaseMetric: type: object properties: _id: type: string description: ID format: objectid available_disk: type: integer description: Available disk format: int64 available_memory: type: integer description: Available memory format: int64 cache_hit_ratio: type: number description: Cache hit ratio format: double connections: type: integer description: Connections format: int32 cpu_usage_percent: type: number description: CPU usage percentage format: float created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid database_id: type: string description: Database ID format: objectid lock_wait_time: type: number description: Lock wait time format: double query_per_second: type: number description: Query per second format: double replication_lag: type: number description: Replication lag format: double total_disk: type: integer description: Total disk format: int64 total_memory: type: integer description: Total memory format: int64 total_query: type: integer description: Total query format: int64 updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid used_disk: type: integer description: Used disk format: int64 used_disk_percent: type: number description: Used disk percentage format: float used_memory: type: integer description: Used memory format: int64 used_memory_percent: type: number description: Used memory percentage format: float ModelsDependency: type: object properties: _id: type: string description: ID format: objectid created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid description: type: string description: Description error: type: string description: Error name: type: string description: Name node_id: type: string description: Node ID format: objectid node_ids: type: array items: type: string format: objectid status: type: string description: Status type: type: string description: Type updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid version: type: string description: Version versions: type: array items: type: string ModelsDependencyConfig: type: object properties: _id: type: string description: ID format: objectid created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid exec_cmd: type: string description: Exec cmd key: type: string description: Type name: type: string description: Name pkg_cmd: type: string description: Pkg cmd pkg_src_url: type: string description: Pkg src url search_ready: type: boolean setup: type: boolean total_dependencies: type: integer format: int32 updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid description: The data to update ModelsDependencyConfigSetup: type: object properties: _id: type: string description: ID format: objectid created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid dependency_config_id: type: string description: Dependency config ID format: objectid error: type: string description: Error node: $ref: '#/components/schemas/ModelsNode' node_id: type: string description: Node ID format: objectid status: type: string description: Status updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid version: type: string description: Version versions: type: array items: $ref: '#/components/schemas/ModelsDependencyDriver' description: Versions ModelsDependencyDriver: type: object properties: name: type: string description: Name version: type: string description: Version ModelsDependencyLog: type: object properties: _id: type: string description: ID format: objectid content: type: string description: Content created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid target_id: type: string description: Target ID format: objectid updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid ModelsEnvironment: type: object properties: _id: type: string description: ID format: objectid created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid key: type: string description: Type updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid value: type: string description: Value description: The data to update ModelsGit: type: object properties: _id: type: string description: ID format: objectid auth_type: type: string description: Auth type auto_pull: type: boolean description: Auto pull clone_logs: type: array items: type: string description: Clone logs created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid current_branch: type: string description: Current branch error: type: string description: Error name: type: string description: Name password: type: string description: Password refs: type: array items: $ref: '#/components/schemas/VcsGitRef' description: Refs refs_updated_at: type: string description: Refs updated at format: date-time status: type: string description: Status updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid url: type: string description: URL username: type: string description: Username description: The data to update ModelsGitDTO: type: object properties: Git: $ref: '#/components/schemas/ModelsGit' spiders: type: array items: $ref: '#/components/schemas/ModelsSpider' description: Spiders ModelsLLMProvider: type: object properties: _id: type: string description: ID format: objectid api_base_url: type: string description: API base URL for the provider api_key: type: string description: API key for the provider api_version: type: string description: API version for the provider created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid default_model: type: string description: Default model for this provider deployment_name: type: string description: Deployment name for the provider models: type: array items: type: string description: Models supported by this provider name: type: string description: Display name for UI type: type: string description: Provider type (e.g., 'openai', 'azure-openai', 'anthropic', 'gemini') updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid description: The data to update ModelsMetric: type: object properties: _id: type: string description: ID format: objectid available_disk: type: integer description: Available disk format: int64 available_memory: type: integer description: Available memory format: int64 cpu_usage_percent: type: number description: CPU usage percentage format: float created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid disk_read_bytes_rate: type: number description: Disk read bytes rate format: float disk_write_bytes_rate: type: number description: Disk write bytes rate format: float goroutine_count: type: integer description: Current goroutine count format: int32 network_bytes_recv_rate: type: number description: Network bytes recv rate format: float network_bytes_sent_rate: type: number description: Network bytes sent rate format: float node_id: type: string description: Node ID format: objectid total_disk: type: integer description: Total disk format: int64 total_memory: type: integer description: Total memory format: int64 type: type: string description: Type updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid used_disk: type: integer description: Used disk format: int64 used_disk_percent: type: number description: Used disk percentage format: float used_memory: type: integer description: Used memory format: int64 used_memory_percent: type: number description: Used memory percentage format: float ModelsNode: type: object properties: _id: type: string description: ID format: objectid active: type: boolean description: Active active_at: type: string description: Active at format: date-time created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid current_runners: type: integer description: Current runners format: int32 description: type: string description: Description enabled: type: boolean description: Enabled hostname: type: string description: Hostname ip: type: string description: IP is_master: type: boolean description: Is master key: type: string description: Type mac: type: string description: MAC max_runners: type: integer description: Max runners format: int32 name: type: string description: Name status: type: string description: Status updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid description: The data to update ModelsNodeDTO: type: object properties: Node: $ref: '#/components/schemas/ModelsNode' node_groups: type: array items: $ref: '#/components/schemas/ModelsNodeGroup' description: Associated node group ModelsNodeGroup: type: object properties: _id: type: string description: ID format: objectid active_count: type: integer description: Active nodes in group (computed) format: int32 created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid description: type: string description: Node group description name: type: string description: Node group name node_ids: type: array items: type: string format: objectid description: Node IDs in this group total_count: type: integer description: Total nodes in group (computed) format: int32 updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid description: Node group data ModelsNodeGroupDTO: type: object properties: NodeGroup: $ref: '#/components/schemas/ModelsNodeGroup' nodes: type: array items: $ref: '#/components/schemas/ModelsNode' ModelsNotificationAlert: type: object properties: _id: type: string description: ID format: objectid created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid description: type: string description: Description enabled: type: boolean description: Enabled has_metric_target: type: boolean description: Has metric target lasting_seconds: type: integer description: Lasting seconds format: int32 level: type: string description: Level metric_name: type: string description: Metric name metric_target_id: type: string description: Metric target ID format: objectid name: type: string description: Name operator: type: string description: Operator target_value: type: number description: Target value format: float template_key: type: string description: Template key updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid description: The data to update ModelsNotificationChannel: type: object properties: _id: type: string description: ID format: objectid created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid description: type: string description: Description google_oauth2_json: type: string description: Google OAuth2 JSON name: type: string description: Name provider: type: string description: Provider smtp_password: type: string description: SMTP password smtp_port: type: integer description: SMTP port format: int32 smtp_server: type: string description: SMTP server smtp_username: type: string description: SMTP username telegram_bot_token: type: string description: Telegram bot token telegram_chat_id: type: string description: Telegram chat ID type: type: string description: Type enum: - im - mail updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid webhook_url: type: string description: Webhook URL description: The data to update ModelsNotificationRequest: type: object properties: _id: type: string description: ID format: objectid channel: $ref: '#/components/schemas/ModelsNotificationChannel' channel_id: type: string description: Channel ID format: objectid content: type: string description: Content created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid error: type: string description: Error mail_bcc: type: array items: type: string description: Mail BCC mail_cc: type: array items: type: string description: Mail CC mail_to: type: array items: type: string description: Mail to sender_email: type: string description: Sender email sender_name: type: string description: Sender name setting: $ref: '#/components/schemas/ModelsNotificationSetting' setting_id: type: string description: Setting ID format: objectid status: type: string description: Status test: type: boolean description: Test title: type: string description: Title updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid description: The data to update ModelsNotificationRequestDTO: type: object properties: NotificationRequest: $ref: '#/components/schemas/ModelsNotificationRequest' channel: $ref: '#/components/schemas/ModelsNotificationChannel' setting: $ref: '#/components/schemas/ModelsNotificationSetting' ModelsNotificationSetting: type: object properties: _id: type: string description: ID format: objectid channel_ids: type: array items: type: string format: objectid description: Channel IDs created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid description: type: string description: Description enabled: type: boolean description: Enabled mail_bcc: type: array items: type: string description: Mail BCC mail_cc: type: array items: type: string description: Mail CC mail_to: type: array items: type: string description: Mail to name: type: string description: Name sender_email: type: string description: Sender email sender_name: type: string description: Sender name task_trigger: type: string description: Task trigger template: type: string description: Template template_markdown: type: string description: Template markdown template_mode: type: string description: Template mode template_rich_text: type: string description: Template rich text template_rich_text_json: type: string description: Template rich text JSON template_theme: type: string description: Template theme title: type: string description: Title trigger: type: string description: Trigger updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid use_custom_sender_email: type: boolean description: Use custom sender email description: The data to update ModelsNotificationSettingDTO: type: object properties: NotificationSetting: $ref: '#/components/schemas/ModelsNotificationSetting' channels: type: array items: $ref: '#/components/schemas/ModelsNotificationChannel' ModelsProject: type: object properties: _id: type: string description: ID format: objectid created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid description: type: string description: Description name: type: string description: Name updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid description: The data to update ModelsProjectDTO: type: object properties: Project: $ref: '#/components/schemas/ModelsProject' spiders: type: array items: $ref: '#/components/schemas/ModelsSpider' ModelsRole: type: object properties: _id: type: string description: ID format: objectid created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid description: type: string description: Description name: type: string description: Name root_admin: type: boolean routes: type: array items: type: string description: Routes updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid users: type: integer format: int32 description: The data to update ModelsSchedule: type: object properties: _id: type: string description: ID format: objectid cmd: type: string description: Cmd created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid cron: type: string description: Cron description: type: string description: Description enabled: type: boolean description: Enabled entry_id: type: integer description: Entry ID format: int32 execution_strategy: type: string description: Execution Strategy mode: type: string description: Mode name: type: string description: Name node_group_ids: type: array items: type: string format: objectid description: Node Group IDs node_ids: type: array items: type: string format: objectid description: Node IDs param: type: string description: Param priority: type: integer description: Priority format: int32 spider: $ref: '#/components/schemas/ModelsSpider' spider_id: type: string description: Spider ID format: objectid updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid description: The data to update ModelsScheduleDTO: type: object properties: Schedule: $ref: '#/components/schemas/ModelsSchedule' spider: $ref: '#/components/schemas/ModelsSpider' ModelsSetting: type: object properties: _id: type: string description: ID format: objectid created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid key: type: string description: Type updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid value: type: object additionalProperties: {} description: Value description: The data to update ModelsSpider: type: object properties: _id: type: string description: ID format: objectid cmd: type: string description: Execute command col_id: type: string description: Data collection id format: objectid deprecated: true col_name: type: string description: Data collection name created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid database_id: type: string description: Database Id format: objectid db_name: type: string description: Database name description: type: string description: Description git_id: type: string description: Related Git ID format: objectid git_root_path: type: string description: Git root path mode: type: string description: Default task mode enum: - random - all - selected-nodes name: type: string description: Spider name node_group_ids: type: array items: type: string format: objectid description: Default node group ids, used in selected-node-groups mode node_ids: type: array items: type: string format: objectid description: Default node ids, used in selected-nodes mode param: type: string description: Default task param priority: type: integer description: Priority format: int32 default: 5 project_id: type: string description: Project ID format: objectid template: type: string description: Spider template template_params: $ref: '#/components/schemas/ModelsSpiderTemplateParams' updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid description: The spider data to create ModelsSpiderDTO: type: object properties: Spider: $ref: '#/components/schemas/ModelsSpider' database: $ref: '#/components/schemas/ModelsDatabase' git: $ref: '#/components/schemas/ModelsGit' last_task: $ref: '#/components/schemas/ModelsTask' project: $ref: '#/components/schemas/ModelsProject' stat: $ref: '#/components/schemas/ModelsSpiderStat' ModelsSpiderStat: type: object properties: _id: type: string description: ID format: objectid average_runtime_duration: type: integer format: int64 average_total_duration: type: integer format: int64 average_wait_duration: type: integer format: int64 created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid last_task_id: type: string description: Last task ID format: objectid results: type: integer description: Result count format: int32 runtime_duration: type: integer description: Runtime duration (in second) format: int64 tasks: type: integer description: Task count format: int32 total_duration: type: integer description: Total duration (in second) format: int64 updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid wait_duration: type: integer description: Wait duration (in second) format: int64 ModelsSpiderTemplateParams: type: object properties: allowed_domains: type: string description: Allowed domains project_name: type: string description: Project name spider_name: type: string description: Spider name start_urls: type: string description: Start urls description: Spider template params ModelsTask: type: object properties: _id: type: string description: ID format: objectid cmd: type: string description: Command created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid error: type: string description: Error mode: type: string description: Mode node: $ref: '#/components/schemas/ModelsNode' node_group_ids: type: array items: type: string format: objectid node_id: type: string description: Node ID format: objectid node_ids: type: array items: type: string format: objectid param: type: string description: Parameter pid: type: integer description: Process ID format: int32 priority: type: integer description: Priority format: int32 schedule: $ref: '#/components/schemas/ModelsSchedule' schedule_id: type: string description: Schedule ID format: objectid spider: $ref: '#/components/schemas/ModelsSpider' spider_id: type: string description: Spider ID format: objectid stat: $ref: '#/components/schemas/ModelsTaskStat' status: type: string description: 'Status: pending, assigned, running, finished, error, cancelled, abnormal.' updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid description: The data to update ModelsTaskDTO: type: object properties: Task: $ref: '#/components/schemas/ModelsTask' node: $ref: '#/components/schemas/ModelsNode' schedule: $ref: '#/components/schemas/ModelsSchedule' spider: $ref: '#/components/schemas/ModelsSpider' stat: $ref: '#/components/schemas/ModelsTaskStat' ModelsTaskStat: type: object properties: _id: type: string description: ID format: objectid created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid ended_at: type: string description: End time format: date-time result_count: type: integer description: Result count format: int64 runtime_duration: type: integer description: Runtime duration (in millisecond) format: int64 started_at: type: string description: Start time format: date-time total_duration: type: integer description: Total duration (in millisecond) format: int64 updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid wait_duration: type: integer description: Wait duration (in millisecond) format: int64 ModelsToken: type: object properties: _id: type: string description: ID format: objectid created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid name: type: string description: Name token: type: string description: Token updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid description: The data to update ModelsUser: type: object properties: _id: type: string description: ID format: objectid created_at: type: string description: Created timestamp format: date-time created_by: type: string description: Created by format: objectid email: type: string description: Email first_name: type: string description: First name last_name: type: string description: Last name role: type: string description: Role role_id: type: string description: Role ID format: objectid root_admin: type: boolean description: Root admin root_admin_role: type: boolean routes: type: array items: type: string updated_at: type: string description: Updated timestamp format: date-time updated_by: type: string description: Updated by format: objectid username: type: string description: Username description: The data to update Modify_database_tableInput: type: object properties: database_name: type: string description: Name of the database table: $ref: '#/components/schemas/EntityDatabaseTable' MultipartFileHeader: type: object properties: Filename: type: string Header: type: object additionalProperties: type: array items: type: string Size: type: integer format: int64 description: The file data (used for form requests) POST_llm_providersInput: type: object properties: data: $ref: '#/components/schemas/ModelsLLMProvider' required: - data PUT_llm_providers_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsLLMProvider' required: - data Post_git_changesInput: type: object properties: changes: type: array items: $ref: '#/components/schemas/VcsGitFileStatus' description: The changes to stage required: - changes Post_llm_chat_streamInput: type: object properties: conversation_id: type: string description: Optional conversation ID for continuing a chat max_tokens: type: integer description: Maximum number of tokens to generate format: int32 model: type: string description: Model name other_params: type: object additionalProperties: {} description: Provider-specific parameters provider_id: type: string description: Id of LLM provider format: objectid query: type: string description: User query system_prompt: type: string description: System prompt temperature: type: number description: Sampling temperature (0.0 to 1.0) format: double top_p: type: number description: Top P sampling format: double use_mcp: type: boolean description: Whether to use MCP tools required: - model - provider_id - query PrimitiveE: type: object properties: Key: type: string Value: description: Value of any type, including null nullable: true Query_databaseInput: type: object properties: database: type: string description: Name of the database to query query: type: string description: SQL query to execute required: - query Rename_database_tableInput: type: object properties: database_name: type: string description: Name of the database new_table_name: type: string description: New name for the table table_name: type: string description: Current name of the table required: - new_table_name - table_name Rename_git_fileInput: type: object properties: newPath: type: string description: The new path for the file path: type: string description: The path of the file to rename required: - newPath - path Rename_spider_fileInput: type: object properties: newPath: type: string description: New file path path: type: string description: File path to rename Replace_conversation_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsChatConversation' required: - data Replace_data_collection_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsDataCollection' required: - data Replace_database_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsDatabase' required: - data Replace_dependencies_setting_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsDependencyConfig' required: - data Replace_dependency_configInput: type: object properties: exec_cmd: type: string description: The command to execute pkg_cmd: type: string description: The package command pkg_src_url: type: string description: The package source URL required: - exec_cmd - pkg_cmd Replace_environment_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsEnvironment' required: - data Replace_git_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsGit' required: - data Replace_meInput: type: object properties: data: $ref: '#/components/schemas/ModelsUser' Replace_node_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsNode' required: - data Replace_notifications_alert_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationAlert' required: - data Replace_notifications_channel_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationChannel' required: - data Replace_notifications_request_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationRequest' required: - data Replace_notifications_setting_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationSetting' required: - data Replace_project_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsProject' required: - data Replace_role_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsRole' required: - data Replace_schedule_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsSchedule' required: - data Replace_setting_by_typeInput: type: object properties: data: $ref: '#/components/schemas/ModelsSetting' required: - data Replace_spider_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsSpider' required: - data Replace_task_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsTask' required: - data Replace_token_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsToken' required: - data Replace_user_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsUser' required: - data Run_scheduleInput: type: object properties: cmd: type: string description: Command mode: type: string description: Run mode enum: - random - all - selected-nodes - selected-node-groups node_group_ids: type: array items: type: string description: Node group IDs node_ids: type: array items: type: string description: Node IDs param: type: string description: Parameters priority: type: integer description: Priority format: int32 default: 5 Run_spiderInput: type: object properties: cmd: type: string description: Command mode: type: string description: 'Run mode: random,all-nodes,selected-nodes,selected-node-groups' default: random enum: - random - all-nodes - selected-nodes - selected-node-groups node_group_ids: type: array items: type: string description: Node group IDs, used in selected-node-groups mode node_ids: type: array items: type: string description: Node IDs, used in selected-nodes mode param: type: string description: Parameters priority: type: integer description: Priority format: int32 default: 5 schedule_id: type: string description: Schedule ID format: objectid Run_taskInput: type: object properties: cmd: type: string mode: type: string node_group_ids: type: array items: type: string node_ids: type: array items: type: string param: type: string priority: type: integer format: int32 spider_id: type: string required: - spider_id Save_git_dirInput: type: object properties: path: type: string description: The path of the directory to create required: - path Save_git_fileInput: type: object properties: File: $ref: '#/components/schemas/MultipartFileHeader' data: type: string description: The file content (used for JSON requests) path: type: string description: The path where the file will be saved required: - path Save_spider_dirInput: type: object properties: path: type: string description: File path to save Save_spider_fileInput: type: object properties: File: $ref: '#/components/schemas/MultipartFileHeader' data: type: string description: File content path: type: string description: File path to save Test_notification_channelInput: type: object properties: locale: type: string description: Locale for the test message default: en enum: - en - zh to_mail: type: array items: type: string description: Email addresses to send test mail to (only for mail type) Uninstall_dependencyInput: type: object properties: lang: type: string description: The programming language of the dependencies mode: type: string description: Uninstallation mode ('all' or specific nodes) names: type: array items: type: string description: The names of the dependencies to uninstall node_ids: type: array items: type: string format: objectid description: The IDs of nodes to uninstall from (only used when mode is not 'all') Uninstall_dependency_config_setupInput: type: object properties: mode: type: string description: Uninstallation mode ('all' or specific nodes) node_ids: type: array items: type: string format: objectid description: The IDs of nodes to uninstall from (only used when mode is not 'all') Update_conversation_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsChatConversation' required: - data Update_data_collection_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsDataCollection' required: - data Update_database_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsDatabase' required: - data Update_database_orm_statusInput: type: object properties: data: $ref: '#/components/schemas/ControllersPutDatabaseOrmStatusRequestBody' Update_dependencies_setting_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsDependencyConfig' required: - data Update_environment_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsEnvironment' required: - data Update_git_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsGit' required: - data Update_llm_provider_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsLLMProvider' required: - data Update_node_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsNode' required: - data Update_node_group_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsNodeGroup' required: - data Update_notifications_alert_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationAlert' required: - data Update_notifications_channel_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationChannel' required: - data Update_notifications_request_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationRequest' required: - data Update_notifications_setting_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsNotificationSetting' required: - data Update_project_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsProject' required: - data Update_role_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsRole' required: - data Update_schedule_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsSchedule' required: - data Update_spider_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsSpider' required: - data Update_task_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsTask' required: - data Update_token_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsToken' required: - data Update_user_by_idInput: type: object properties: data: $ref: '#/components/schemas/ModelsUser' required: - data VcsGitFileStatus: type: object properties: children: type: array items: $ref: '#/components/schemas/VcsGitFileStatus' extra: type: string is_dir: type: boolean name: type: string path: type: string staging: type: string worktree: type: string VcsGitLog: type: object properties: author_email: type: string author_name: type: string hash: type: string msg: type: string refs: type: array items: $ref: '#/components/schemas/VcsGitRef' timestamp: type: string format: date-time VcsGitRef: type: object properties: full_name: type: string hash: type: string name: type: string remote_track: type: string timestamp: type: string format: date-time type: type: string securitySchemes: apiToken: type: apiKey in: header name: API Token tags: - name: AuthGroup description: Router group that requires authentication - name: AnonymousGroup description: Router group that doesn't require authentication - name: SyncAuthGroup description: Router group for sync operations with special auth - name: Nodes description: APIs for nodes management - name: Projects description: APIs for projects management - name: Spiders description: APIs for spiders management - name: Schedules description: APIs for schedules management - name: Tasks description: APIs for tasks management - name: Users description: APIs for users management - name: Tokens description: APIs for PAT management - name: Environments description: APIs for environment variables management - name: Data Collections description: APIs for data collections management - name: Export description: APIs for exporting data - name: Filters description: APIs for data collections filters management - name: Settings description: APIs for settings management - name: Stats description: APIs for data stats - name: System description: APIs for system info - name: Auth description: APIs for authentication - name: Sync description: APIs for sync operations - name: Git description: APIs for git repositories management - name: Dependencies description: APIs for dependencies management - name: Notification Settings description: APIs for notification settings management - name: Notification Channels description: APIs for notification channels management - name: Notification Requests description: APIs for notification requests management - name: Notification Alerts description: APIs for notification alerts management - name: Node Groups description: APIs for node groups management - name: Databases description: APIs for databases management - name: Roles description: APIs for roles management