Apidog · Schema

Apidog Import Result

The result returned by the Apidog API after an import operation (OpenAPI, Swagger, or Postman Collection v2). Counters are reported per resource type: endpoint, schema, endpointFolder, schemaFolder, endpointCase.

AI CodingAPI DesignAPI LifecycleAPI TestingCollaborationDesign-FirstDocumentationMCPMockingPlatform

Properties

Name Type Description
success boolean Whether the import operation completed successfully.
data object Details about the imported resources.
View JSON Schema on GitHub

JSON Schema

apidog-import-result-schema.json Raw ↑
{
  "$id": "https://raw.githubusercontent.com/api-evangelist/apidog/refs/heads/main/json-schema/apidog-import-result-schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Apidog Import Result",
  "description": "The result returned by the Apidog API after an import operation (OpenAPI, Swagger, or Postman Collection v2). Counters are reported per resource type: endpoint, schema, endpointFolder, schemaFolder, endpointCase.",
  "type": "object",
  "required": [
    "success"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Whether the import operation completed successfully."
    },
    "data": {
      "type": "object",
      "description": "Details about the imported resources.",
      "properties": {
        "endpoint": {
          "$ref": "#/$defs/ResourceCounters"
        },
        "schema": {
          "$ref": "#/$defs/ResourceCounters"
        },
        "endpointFolder": {
          "$ref": "#/$defs/ResourceCounters"
        },
        "schemaFolder": {
          "$ref": "#/$defs/ResourceCounters"
        },
        "endpointCase": {
          "$ref": "#/$defs/ResourceCounters"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            }
          }
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false,
  "$defs": {
    "ResourceCounters": {
      "type": "object",
      "description": "Counters returned for each resource type after an import operation.",
      "properties": {
        "created": {
          "type": "integer",
          "minimum": 0
        },
        "updated": {
          "type": "integer",
          "minimum": 0
        },
        "failed": {
          "type": "integer",
          "minimum": 0
        },
        "ignored": {
          "type": "integer",
          "minimum": 0
        }
      },
      "additionalProperties": false
    }
  }
}