Page History
Search API Builds an html for each of the classes for data structure, generating a built-in documentation base on this models
You can access the page using the link for Configuration Documentation
Generate Configuration Documentation
This endpoint generates the documentation for all configurations (JSON schemas) in the server.
Parameters
| Parameter | Type | Description |
|---|---|---|
| overwrite | boolean | If set to true, the current documentation will be deleted and a new one will be created. Default is false. |
| Table of Contents | ||
|---|---|---|
|
Example
| Code Block | ||
|---|---|---|
| ||
PUT /es/api/v1/documentation/schemas/config?overwrite=true |
Response
Successful Response [200]
| Code Block |
|---|
Schema Documentation Created |
Validation Error [422]
| Code Block |
|---|
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
} |
Delete Configuration Documentation
Parameters
| Parameter | Type | Description |
|---|---|---|
| name | string |
Example
| Code Block | ||
|---|---|---|
| ||
DELETE /es/api/v1/documentation/schemas/config |
Response
Successful Response [200]
| Code Block |
|---|
Schema Documentation Deleted |
Overview
Content Tools