You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

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

ParameterTypeDescription
overwritebooleanIf set to true, the current documentation will be deleted and a new one will be created. Default is false.

Example

PUT /es/api/v1/documentation/schemas/config?overwrite=true

Response

Successful Response [200]

Schema Documentation Created

Validation Error [422]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Configuration Documentation

Parameters

ParameterTypeDescription
namestring

Example

DELETE /es/api/v1/documentation/schemas/config

Response

Successful Response [200]

Schema Documentation Deleted
  • No labels