Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Import an API reference with projectVersionId, userId and a spec file url or a file type.
{
"project_version_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"user_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"force_import": true,
"url": "https://petstore.swagger.io/v2/swagger.json",
"file": null
}The ID of the project version
The ID of the team account
true : The errors and alerts will not be shown while importing the spec file
false : The errors and alerts will be shown while importing the spec file
Url of the spec file
File path of the spec file
Success
This is the sample response for single API reference import with server variables.
{
"data": {
"categories_created": 23,
"articles_created": 23,
"api_reference_id": "9874c1d9-033f-484c-8e3e-c343301eae57",
"errors": [],
"alerts": []
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}This is the sample response for single API reference import without server variables.
{
"data": {
"categories_created": 3,
"articles_created": 23,
"api_reference_id": "9874c1d9-033f-484c-8e3e-c343301eae57",
"errors": [],
"alerts": []
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [
{
"extension_data": null,
"description": "You may not be able to use try-it feature. Looks like server variables aren’t defined in your OpenAPI Specification file.",
"warning_code": null
}
],
"information": []
}This is the sample response for single API reference import with force import as false.
{
"data": {
"categories_created": 3,
"articles_created": 23,
"api_reference_id": "9874c1d9-033f-484c-8e3e-c343301eae57",
"errors": [
{
"message": "Declared path parameter 'contentId' needs to be defined as a path parameter at either the path or operation level",
"pointer": "#/paths/~1v2~1Content~1{Id}~1version~1{contentCategoryId}/delete/parameters/2/in"
}
],
"alerts": [
{
"message": "Data and type mismatch found.",
"pointer": "#/paths/~1v2~1Content/{Id}/depete/response/200/content/application~1json/examples/Content"
}
]
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Import response data
Total category created
Total article created
Api reference ID
Error log response
Descriptive message of the problem
Path where the problem occures
Alerts log response
Descriptive message of the problem
Path where the problem occures
Extention data for customer API response
Status indication for customer API response
Errors in the customer API response
Thids is the Extention data object
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Extention Data for customer Api warning
Warning description
warning code for customer Api base response
Information passed by the customer API response
Extention data for customer Api response information
status description for customer Api response information
Bad Request
Kindly ensure that the given project version ID is valid.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The supplied project version id d2eafb73-ccb6-4d15-9c4a-959b3c232ddba does not exist in your project",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly ensure that the given user ID is valid.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de8a' does not exist in your project.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}You had reached your maximum API reference limit, for continuing add a new version.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Unable to add API Reference: Maximum API Reference limit reached",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}You have to provide a valid OAS spec file URL.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Invalid Url",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}You have to provide only a valid OAS spec file or a spec file URL.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "You can only upload URL or a spec file.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}You have to upload a valid JSON or a YAML file.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Only YAML or JSON files are allowed.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Extention data for customer API response
Status indication for customer API response
Errors in the customer API response
Thids is the Extention data object
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Extention Data for customer Api warning
Warning description
warning code for customer Api base response
Information passed by the customer API response
Extention data for customer Api response information
status description for customer Api response information