view-store-api/me.ahoo.wow.viewstore.api.wording

Package-level declarations

Types

@Summary(value = "Clear the wording of a dataset")

data class ClearDatasetWording(val dataset: String)

Clears a dataset's wording, which then reads as none: POST /view-store/dataset_wording/clear-dataset-wording. Its id is derived as SetDatasetWording's, so the request names none (Unaddressed).

DatasetWordingCleared

@Summary(value = "A dataset's wording was cleared")

data object DatasetWordingCleared

DatasetWordingSet

@Summary(value = "A dataset's wording was set")

data class DatasetWordingSet(val dataset: String, val appId: String, val title: String?, val recordNoun: String?, val fields: Map<String, Any?>?)

SetDatasetWording

@AllowCreate

@Summary(value = "Set the wording of a dataset")

data class SetDatasetWording(val dataset: String, val title: String? = null, val recordNoun: String? = null, val fields: Map<String, Any?>? = null)

Sets the wording a tenant's readers see over one dataset in one application: its title, its record noun and its fields' labels, order and narrowing (the view engine's DatasetOverrides). The wording's id is derived on the server from the application and the dataset, so the route names none: POST /view-store/dataset_wording/set-dataset-wording. The expected version If-Match: "0" is "never written".