openadr3.api
OpenADR 3 API client library. Spec-driven HTTP client built on Martian with the OpenAPI spec as the single source of truth.
Functions return raw HTTP responses by default. Use the coerced helpers (programs, events, vens, etc.) to get namespaced Clojure entities.
OpenADR 3 API client library. Spec-driven HTTP client built on Martian with the OpenAPI spec as the single source of truth. Functions return raw HTTP responses by default. Use the coerced helpers (programs, events, vens, etc.) to get namespaced Clojure entities.
- all-routes
- authorized?
- body
- build-shared-http-client
- client-type
- create-authentication-header
- create-bl-client
- create-event
- create-program
- create-report
- create-resource
- create-subscription
- create-user-agent-header
- create-ven
- create-ven-client
- default-spec-version
- default-user-agent
- default-vtn-url
- delete-event
- delete-program
- delete-report
- delete-resource
- delete-subscription
- delete-ven
- endpoint-scopes
- event
- events
- find-program-by-name
- find-ven-by-name
- get-auth-server
- get-event-by-id
- get-events
- get-handler
- get-mqtt-topics-events
- get-mqtt-topics-program
- get-mqtt-topics-program-events
- get-mqtt-topics-programs
- get-mqtt-topics-reports
- get-mqtt-topics-resources
- get-mqtt-topics-subscriptions
- get-mqtt-topics-ven
- get-mqtt-topics-ven-events
- get-mqtt-topics-ven-programs
- get-mqtt-topics-ven-resources
- get-mqtt-topics-vens
- get-notifiers
- get-program-by-id
- get-programs
- get-report-by-id
- get-reports
- get-resource-by-id
- get-subscription-by-id
- get-subscriptions
- get-token
- get-unauthenticated-routes
- get-ven-by-id
- get-vens
- hash-map-by
- inject-http-client
- lib-version
- program
- programs
- read-openapi-spec
- report
- reports
- safe-default-interceptors
- scopes
- search-events
- search-programs
- search-reports
- search-subscriptions
- search-ven-resources
- search-vens
- spec-path
- spec-versions
- subscription
- subscriptions
- success?
- turn-off-exception-throwing
- update-event
- update-program
- update-report
- update-resource
- update-subscription
- update-ven
- ven
- vens
openadr3.entities
Two-layer data model for OpenADR 3 entities.
Raw layer: camelCase keys, string values — direct from the API JSON. Coerced layer: namespaced keywords, ZonedDateTimes, Durations, tick intervals.
Every coerced entity preserves the original raw data as :openadr/raw metadata.
Coercion of ValuesMap payloads is extensible via the coerce-payload multimethod,
dispatching on the payload :type string.
Schemas live in dedicated namespaces: openadr3.entities.schema — coerced entity schemas (the public contract) openadr3.entities.schema.raw — raw API schemas (boundary validation)
Two-layer data model for OpenADR 3 entities. Raw layer: camelCase keys, string values — direct from the API JSON. Coerced layer: namespaced keywords, ZonedDateTimes, Durations, tick intervals. Every coerced entity preserves the original raw data as :openadr/raw metadata. Coercion of ValuesMap payloads is extensible via the `coerce-payload` multimethod, dispatching on the payload :type string. Schemas live in dedicated namespaces: openadr3.entities.schema — coerced entity schemas (the public contract) openadr3.entities.schema.raw — raw API schemas (boundary validation)
- ->event
- ->interval
- ->interval-period
- ->notification
- ->object-operation
- ->program
- ->report
- ->report-resource
- ->resource
- ->subscription
- ->values-map
- ->ven
- ->zoned
- coerce
- coerce-payload
- notification?
- validate-raw-event
- validate-raw-program
- validate-raw-report
- validate-raw-resource
- validate-raw-subscription
- validate-raw-ven
openadr3.entities.schema
Malli schemas for coerced OpenADR 3 entities.
These describe the Clojure-native shape produced by openadr3.entities coercion:
namespaced keywords, ZonedDateTimes, Durations, and tick intervals.
Malli schemas for coerced OpenADR 3 entities. These describe the Clojure-native shape produced by `openadr3.entities` coercion: namespaced keywords, ZonedDateTimes, Durations, and tick intervals.
openadr3.entities.schema.raw
Malli schemas for the raw OpenADR 3 API response shape.
These mirror the JSON exactly: camelCase keys, string values.
Most consumers should use openadr3.entities.schema (the coerced schemas)
instead — these are primarily useful for boundary validation.
Malli schemas for the raw OpenADR 3 API response shape. These mirror the JSON exactly: camelCase keys, string values. Most consumers should use `openadr3.entities.schema` (the coerced schemas) instead — these are primarily useful for boundary validation.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |