api

type BackupRequest struct {
	// BackupDir Absolute server-side directory path for the backup.
	BackupDir string `json:"backupDir"`

	// Filter Space-separated list of knot filter names (without the leading `+`)
	// to control what is included in the backup.
	Filter *string `json:"filter,omitempty"`
}

type BadRequest = Error

type Config = string

type ConfigID = string

type ConfigImportRequest struct {
	// Filename Absolute server-side path to the configuration file.
	Filename string `json:"filename"`

	// Nopurge When `true`, existing confdb data is preserved; the file is merged
	// in rather than replacing the current configuration.
	Nopurge *bool `json:"nopurge,omitempty"`
}

type ConfigItem struct {
	// Data Item value or list of values. Single-value items are returned as
	// a string; multi-value items are returned as an array of strings.
	Data *ConfigItem_Data `json:"data,omitempty"`

	// Id Section identifier (the bracketed part in `zone[example.com]`).
	// Empty when the section has no per-instance identifiers.
	Id *string `json:"id,omitempty"`

	// Item Item name within the section.
	Item *string `json:"item,omitempty"`

	// Section Configuration section name.
	Section *string `json:"section,omitempty"`
}

type ConfigItemData0 = string

type ConfigItemData1 = []string

type ConfigItem_Data struct {
	// contains filtered or unexported fields
}

type ConfigSection = string

type ConfigSetRequest struct {
	// Data One or more data values to set. Provide a string for a
	// single value or an array for multiple values.
	Data ConfigSetRequest_Data `json:"data"`

	// Id Section identifier, if applicable (e.g. a zone name for `zone`
	// sections). Omit or leave empty for sections without identifiers.
	Id *string `json:"id,omitempty"`

	// Item Item name within the section.
	Item string `json:"item"`

	// Section Configuration section name.
	Section string `json:"section"`
}

type ConfigSetRequestData0 = string

type ConfigSetRequestData1 = []string

type ConfigSetRequest_Data struct {
	// contains filtered or unexported fields
}

type Created = map[string]interface{}

type DeleteConfigTransactionItemParams struct {
	// Section Configuration section name (e.g. `server`, `zone`, `remote`).
	Section *ConfigSection `form:"section,omitempty" json:"section,omitempty"`

	// Id Section identifier — the bracketed part in `zone[example.com]`. Used
	// for sections that have per-instance configuration.
	Id *ConfigID `form:"id,omitempty" json:"id,omitempty"`

	// Item Item name within the section (e.g. `listen`, `file`).
	Item *Config `form:"item,omitempty" json:"item,omitempty"`

	// Data Specific data value to remove. Omit to remove all values for the
	// item.
	Data *string `form:"data,omitempty" json:"data,omitempty"`
}

type DeleteZoneRecordParams struct {
	// Data Specific rdata value to remove (presentation format). Omit to
	// remove all records matching `owner` and `type`.
	Data *string `form:"data,omitempty" json:"data,omitempty"`
}

type DeleteZoneTransactionRecordParams struct {
	// Data Specific rdata value to remove (presentation format). Omit to
	// remove all records matching `owner` and `type`.
	Data *string `form:"data,omitempty" json:"data,omitempty"`
}

type Error struct {
	// Error Human-readable error message from the knot control socket.
	Error string `json:"error"`
}

type GetConfigExportParams struct {
	// Schema When true, export the JSON schema instead of the configuration.
	Schema *bool `form:"schema,omitempty" json:"schema,omitempty"`

	// Filename Server-side path to write the export to. When omitted, the export
	// is returned in the response body.
	Filename *string `form:"filename,omitempty" json:"filename,omitempty"`
}

type GetConfigParams struct {
	// Section Configuration section name (e.g. `server`, `zone`, `remote`).
	Section *ConfigSection `form:"section,omitempty" json:"section,omitempty"`

	// Id Section identifier — the bracketed part in `zone[example.com]`. Used
	// for sections that have per-instance configuration.
	Id *ConfigID `form:"id,omitempty" json:"id,omitempty"`

	// Item Item name within the section (e.g. `listen`, `file`).
	Item *Config `form:"item,omitempty" json:"item,omitempty"`
}

type GetConfigTransactionDiffParams struct {
	// Section Configuration section name (e.g. `server`, `zone`, `remote`).
	Section *ConfigSection `form:"section,omitempty" json:"section,omitempty"`

	// Id Section identifier — the bracketed part in `zone[example.com]`. Used
	// for sections that have per-instance configuration.
	Id *ConfigID `form:"id,omitempty" json:"id,omitempty"`

	// Item Item name within the section (e.g. `listen`, `file`).
	Item *Config `form:"item,omitempty" json:"item,omitempty"`
}

type GetConfigTransactionItemParams struct {
	// Section Configuration section name (e.g. `server`, `zone`, `remote`).
	Section *ConfigSection `form:"section,omitempty" json:"section,omitempty"`

	// Id Section identifier — the bracketed part in `zone[example.com]`. Used
	// for sections that have per-instance configuration.
	Id *ConfigID `form:"id,omitempty" json:"id,omitempty"`

	// Item Item name within the section (e.g. `listen`, `file`).
	Item *Config `form:"item,omitempty" json:"item,omitempty"`
}

type GetStatsParams struct {
	// Module Module name (e.g. `mod-stats`). Omit to return all modules.
	Module *string `form:"module,omitempty" json:"module,omitempty"`

	// Counter Counter name within the module. Requires `module` to be set.
	Counter *string `form:"counter,omitempty" json:"counter,omitempty"`
}

type GetStatusParams struct {
	// Detail Optional detail level passed to the status command.
	Detail *string `form:"detail,omitempty" json:"detail,omitempty"`
}

type GetZoneRecordsParams struct {
	// Owner Filter by owner name (FQDN, e.g. `www.example.com.`).
	Owner *string `form:"owner,omitempty" json:"owner,omitempty"`

	// Type Filter by record type (e.g. `A`, `AAAA`, `MX`).
	Type *string `form:"type,omitempty" json:"type,omitempty"`
}

type GetZoneStatsParams struct {
	// Module Module name. Omit to return all modules.
	Module *string `form:"module,omitempty" json:"module,omitempty"`

	// Counter Counter name within the module. Requires `module` to be set.
	Counter *string `form:"counter,omitempty" json:"counter,omitempty"`
}

type GetZoneStatusParams struct {
	// Filter Status fields to include in the response.
	Filter *[]GetZoneStatusParamsFilter `form:"filter,omitempty" json:"filter,omitempty"`
}

type GetZoneStatusParamsFilter string

type GetZoneTransactionRecordsParams struct {
	// Owner Filter by owner name (FQDN).
	Owner *string `form:"owner,omitempty" json:"owner,omitempty"`

	// Type Filter by record type.
	Type *string `form:"type,omitempty" json:"type,omitempty"`
}

type GetZonesParams struct {
	// Filter Optional filter to apply (e.g. `type=slave`).
	Filter *string `form:"filter,omitempty" json:"filter,omitempty"`
}

type InternalError = Error

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

type MiddlewareFunc func(http.Handler) http.Handler

type NotFound = Error

type OK = map[string]interface{}

type PostConfigImportJSONRequestBody = ConfigImportRequest

type PostZoneBackupJSONRequestBody = BackupRequest

type PostZoneFlushParams struct {
	// Filter Space-separated list of knot filter names (without the leading `+`),
	// e.g. `expire journal-content`.
	Filter *ZoneFilter `form:"filter,omitempty" json:"filter,omitempty"`
}

type PostZoneKeyRolloverParamsKeyType string

type PostZonePurgeParams struct {
	// Filter Space-separated list of knot filter names (without the leading `+`),
	// e.g. `expire journal-content`.
	Filter *ZoneFilter `form:"filter,omitempty" json:"filter,omitempty"`
}

type PostZoneRecordJSONRequestBody = RecordWrite

type PostZoneRecordsBatchJSONRequestBody = RecordBatchRequest

type PostZoneRestoreJSONRequestBody = BackupRequest

type PostZoneTransactionJSONRequestBody = ZoneTransactionBeginRequest

type PutConfigTransactionItemJSONRequestBody = ConfigSetRequest

type PutZoneSerialJSONRequestBody = SerialRequest

type PutZoneTransactionRecordJSONRequestBody = RecordWrite

type Record struct {
	// Data Record data in presentation format.
	Data string `json:"data"`

	// Owner Record owner name (FQDN).
	Owner string `json:"owner"`

	// Ttl Time-to-live in seconds.
	Ttl *int `json:"ttl,omitempty"`

	// Type Record type in uppercase presentation format.
	Type string `json:"type"`
}

type RecordBatchRequest struct {
	// Add Records to add or update.
	Add *[]struct {
		// Data Record data in presentation format.
		Data string `json:"data"`

		// Owner Record owner name (FQDN).
		Owner string `json:"owner"`

		// Ttl TTL in seconds. Omit to use zone default.
		Ttl *int `json:"ttl,omitempty"`

		// Type Record type in uppercase presentation format.
		Type string `json:"type"`
	} `json:"add,omitempty"`

	// Delete Records to delete.
	Delete *[]struct {
		// Data Specific rdata value to remove. Omit to remove all records
		// matching owner and type.
		Data *string `json:"data,omitempty"`

		// Owner Record owner name (FQDN).
		Owner string `json:"owner"`

		// Type Record type in uppercase presentation format.
		Type string `json:"type"`
	} `json:"delete,omitempty"`
}

type RecordBatchResponse struct {
	// Added Number of records added/updated.
	Added *int `json:"added,omitempty"`

	// Deleted Number of records deleted.
	Deleted *int `json:"deleted,omitempty"`

	// Message Success message.
	Message *string `json:"message,omitempty"`
}

type RecordOwner = string

type RecordResponse struct {
	// Data Record data in presentation format.
	Data string `json:"data"`

	// Message Success message.
	Message *string `json:"message,omitempty"`

	// Owner Record owner name (FQDN).
	Owner string `json:"owner"`

	// Ttl TTL in seconds.
	Ttl *int `json:"ttl,omitempty"`

	// Type Record type in uppercase presentation format.
	Type string `json:"type"`
}

type RecordType = string

type RecordWrite struct {
	// Data Record data in presentation format.
	Data string `json:"data"`

	// Ttl TTL in seconds. Omit to use the zone default TTL.
	Ttl *int `json:"ttl,omitempty"`
}

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

type RequiredParamError struct {
	ParamName string
}

type SerialRequest struct {
	// Serial SOA serial update value.
	// - A plain integer sets the serial directly (e.g. `"2024010101"`).
	// - A value prefixed with `+` increments the current serial by that
	//   amount (e.g. `"+1"`).
	Serial string `json:"serial"`
}

type SerialResponse struct {
	// Serial Current SOA serial number.
	Serial int `json:"serial"`
}

type ServeMux interface {
	HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
	ServeHTTP(w http.ResponseWriter, r *http.Request)
}

type ServerInterface interface {
	// Read the active configuration
	// (GET /config)
	GetConfig(w http.ResponseWriter, r *http.Request, params GetConfigParams)
	// Check the server configuration for errors
	// (POST /config/check)
	PostConfigCheck(w http.ResponseWriter, r *http.Request)
	// Export the confdb or its JSON schema
	// (GET /config/export)
	GetConfigExport(w http.ResponseWriter, r *http.Request, params GetConfigExportParams)
	// Import a configuration file into the confdb
	// (POST /config/import)
	PostConfigImport(w http.ResponseWriter, r *http.Request)
	// Initialise the configuration database
	// (POST /config/init)
	PostConfigInit(w http.ResponseWriter, r *http.Request)
	// Begin a configuration write transaction
	// (POST /config/transaction)
	PostConfigTransaction(w http.ResponseWriter, r *http.Request)
	// Roll back the open configuration transaction
	// (POST /config/transaction/abort)
	PostConfigTransactionAbort(w http.ResponseWriter, r *http.Request)
	// Commit the open configuration transaction
	// (POST /config/transaction/commit)
	PostConfigTransactionCommit(w http.ResponseWriter, r *http.Request)
	// Get configuration differences within the open transaction
	// (GET /config/transaction/diff)
	GetConfigTransactionDiff(w http.ResponseWriter, r *http.Request, params GetConfigTransactionDiffParams)
	// Unset a configuration item within the open transaction
	// (DELETE /config/transaction/item)
	DeleteConfigTransactionItem(w http.ResponseWriter, r *http.Request, params DeleteConfigTransactionItemParams)
	// Read a configuration item within the open transaction
	// (GET /config/transaction/item)
	GetConfigTransactionItem(w http.ResponseWriter, r *http.Request, params GetConfigTransactionItemParams)
	// Set a configuration item within the open transaction
	// (PUT /config/transaction/item)
	PutConfigTransactionItem(w http.ResponseWriter, r *http.Request)
	// Reload server configuration and modified zones
	// (POST /reload)
	PostReload(w http.ResponseWriter, r *http.Request)
	// Show global statistics counters
	// (GET /stats)
	GetStats(w http.ResponseWriter, r *http.Request, params GetStatsParams)
	// Check server status
	// (GET /status)
	GetStatus(w http.ResponseWriter, r *http.Request, params GetStatusParams)
	// Stop the server
	// (POST /stop)
	PostStop(w http.ResponseWriter, r *http.Request)
	// List all zones
	// (GET /zones/)
	GetZones(w http.ResponseWriter, r *http.Request, params GetZonesParams)
	// Back up zone data and metadata to a server-side directory
	// (POST /zones/{zone}/backup)
	PostZoneBackup(w http.ResponseWriter, r *http.Request, zone Zone)
	// Check if the zone can be loaded from disk
	// (POST /zones/{zone}/check)
	PostZoneCheck(w http.ResponseWriter, r *http.Request, zone Zone)
	// Flush zone journal into the zone file
	// (POST /zones/{zone}/flush)
	PostZoneFlush(w http.ResponseWriter, r *http.Request, zone Zone, params PostZoneFlushParams)
	// Temporarily postpone automatic zone-changing events
	// (POST /zones/{zone}/freeze)
	PostZoneFreeze(w http.ResponseWriter, r *http.Request, zone Zone)
	// Reload keys from the KASP database and re-sign the zone
	// (POST /zones/{zone}/keys/load)
	PostZoneKeysLoad(w http.ResponseWriter, r *http.Request, zone Zone)
	// Trigger an immediate key rollover
	// (POST /zones/{zone}/keys/{keyType}/rollover)
	PostZoneKeyRollover(w http.ResponseWriter, r *http.Request, zone Zone, keyType PostZoneKeyRolloverParamsKeyType)
	// Confirm that the parent DS record is present after KSK submission
	// (POST /zones/{zone}/ksk-submitted)
	PostZoneKSKSubmitted(w http.ResponseWriter, r *http.Request, zone Zone)
	// Send a NOTIFY to all configured remotes
	// (POST /zones/{zone}/notify)
	PostZoneNotify(w http.ResponseWriter, r *http.Request, zone Zone)
	// Purge zone data, zone file, journal, timers, and KASP data
	// (POST /zones/{zone}/purge)
	PostZonePurge(w http.ResponseWriter, r *http.Request, zone Zone, params PostZonePurgeParams)
	// Read zone records currently being served
	// (GET /zones/{zone}/records)
	GetZoneRecords(w http.ResponseWriter, r *http.Request, zone Zone, params GetZoneRecordsParams)
	// Batch add/update/delete multiple DNS records (convenience endpoint)
	// (POST /zones/{zone}/records/batch)
	PostZoneRecordsBatch(w http.ResponseWriter, r *http.Request, zone Zone)
	// Delete a DNS record (convenience endpoint)
	// (DELETE /zones/{zone}/records/{owner}/{type})
	DeleteZoneRecord(w http.ResponseWriter, r *http.Request, zone Zone, owner RecordOwner, pType RecordType, params DeleteZoneRecordParams)
	// Add or update a DNS record (convenience endpoint)
	// (POST /zones/{zone}/records/{owner}/{type})
	PostZoneRecord(w http.ResponseWriter, r *http.Request, zone Zone, owner RecordOwner, pType RecordType)
	// Force a slave zone refresh
	// (POST /zones/{zone}/refresh)
	PostZoneRefresh(w http.ResponseWriter, r *http.Request, zone Zone)
	// Reload zone from disk
	// (POST /zones/{zone}/reload)
	PostZoneReload(w http.ResponseWriter, r *http.Request, zone Zone)
	// Restore zone data and metadata from a server-side backup directory
	// (POST /zones/{zone}/restore)
	PostZoneRestore(w http.ResponseWriter, r *http.Request, zone Zone)
	// Force slave zone retransfer without a serial check
	// (POST /zones/{zone}/retransfer)
	PostZoneRetransfer(w http.ResponseWriter, r *http.Request, zone Zone)
	// Get the current SOA serial number
	// (GET /zones/{zone}/serial)
	GetZoneSerial(w http.ResponseWriter, r *http.Request, zone Zone)
	// Set or increment the SOA serial number
	// (PUT /zones/{zone}/serial)
	PutZoneSerial(w http.ResponseWriter, r *http.Request, zone Zone)
	// Re-sign the automatically signed zone
	// (POST /zones/{zone}/sign)
	PostZoneSign(w http.ResponseWriter, r *http.Request, zone Zone)
	// Show zone statistics counters
	// (GET /zones/{zone}/stats)
	GetZoneStats(w http.ResponseWriter, r *http.Request, zone Zone, params GetZoneStatsParams)
	// Show zone status
	// (GET /zones/{zone}/status)
	GetZoneStatus(w http.ResponseWriter, r *http.Request, zone Zone, params GetZoneStatusParams)
	// Dismiss a zone freeze
	// (POST /zones/{zone}/thaw)
	PostZoneThaw(w http.ResponseWriter, r *http.Request, zone Zone)
	// Begin a zone transaction
	// (POST /zones/{zone}/transaction)
	PostZoneTransaction(w http.ResponseWriter, r *http.Request, zone Zone)
	// Abort and roll back the open zone transaction
	// (POST /zones/{zone}/transaction/abort)
	PostZoneTransactionAbort(w http.ResponseWriter, r *http.Request, zone Zone)
	// Commit the open zone transaction
	// (POST /zones/{zone}/transaction/commit)
	PostZoneTransactionCommit(w http.ResponseWriter, r *http.Request, zone Zone)
	// Get zone record changes within the open transaction
	// (GET /zones/{zone}/transaction/diff)
	GetZoneTransactionDiff(w http.ResponseWriter, r *http.Request, zone Zone)
	// Read zone records within the open transaction
	// (GET /zones/{zone}/transaction/records)
	GetZoneTransactionRecords(w http.ResponseWriter, r *http.Request, zone Zone, params GetZoneTransactionRecordsParams)
	// Remove records within the open transaction
	// (DELETE /zones/{zone}/transaction/records/{owner}/{type})
	DeleteZoneTransactionRecord(w http.ResponseWriter, r *http.Request, zone Zone, owner RecordOwner, pType RecordType, params DeleteZoneTransactionRecordParams)
	// Add or replace a record within the open transaction
	// (PUT /zones/{zone}/transaction/records/{owner}/{type})
	PutZoneTransactionRecord(w http.ResponseWriter, r *http.Request, zone Zone, owner RecordOwner, pType RecordType)
	// Trigger DNSSEC validation of the zone
	// (POST /zones/{zone}/validate)
	PostZoneValidate(w http.ResponseWriter, r *http.Request, zone Zone)
	// Temporarily disable outgoing AXFR/IXFR
	// (POST /zones/{zone}/xfr/freeze)
	PostZoneXFRFreeze(w http.ResponseWriter, r *http.Request, zone Zone)
	// Re-enable outgoing AXFR/IXFR
	// (POST /zones/{zone}/xfr/thaw)
	PostZoneXFRThaw(w http.ResponseWriter, r *http.Request, zone Zone)
}

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

type ServerStatus struct {
	Status *ServerStatusStatus `json:"status,omitempty"`

	// Version Knot DNS version string.
	Version *string `json:"version,omitempty"`

	// Workers Number of worker threads.
	Workers *int `json:"workers,omitempty"`
}

type ServerStatusStatus string

type Stats map[string]map[string]int

type StdHTTPServerOptions struct {
	BaseURL          string
	BaseRouter       ServeMux
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

type Unauthorized = Error

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

type Zone = string

type ZoneDiff struct {
	// Added Records added by the transaction.
	Added *[]Record `json:"added,omitempty"`

	// Removed Records removed by the transaction.
	Removed *[]Record `json:"removed,omitempty"`
}

type ZoneFilter = string

type ZoneList = []ZoneStatus

type ZoneStatus struct {
	// Frozen Whether automatic zone changes are suspended.
	Frozen *bool `json:"frozen,omitempty"`

	// NextEvent Name of the next scheduled internal event.
	NextEvent *string `json:"nextEvent,omitempty"`

	// Role Zone role on this server.
	Role *ZoneStatusRole `json:"role,omitempty"`

	// Serial Current SOA serial number.
	Serial *int `json:"serial,omitempty"`

	// Transaction Whether a write transaction is currently open.
	Transaction *bool `json:"transaction,omitempty"`

	// XfrFrozen Whether outgoing AXFR/IXFR is disabled.
	XfrFrozen *bool   `json:"xfrFrozen,omitempty"`
	Zone      *string `json:"zone,omitempty"`
}

type ZoneStatusRole string

type ZoneTransactionBeginRequest struct {
	// Benevolent When `true`, tolerate a pre-existing transaction from another
	// client instead of returning a 409 conflict.
	Benevolent *bool `json:"benevolent,omitempty"`
}