Common

Contents

Common#

GitHub

This section covers features and configuration that are shared across multiple BaSyx Go components, including Swagger/OpenAPI, common configuration, observability, pagination, validation, and other common API behavior.

Contents#

  • Deployment and Versions — Covers version alignment, database initialization, persistent state, and deployment considerations shared across BaSyx Go components.

  • Swagger UI and OpenAPI — Describes the Swagger UI and OpenAPI documents exposed by BaSyx Go components.

  • General Configuration — Provides the common YAML configuration options and their environment-variable mappings.

  • Runtime Security — Explains OIDC authentication, ABAC authorization, trustlists, claims, and resource filtering for runtime API access.

  • ABAC Policy Management — Explains PostgreSQL-backed policy versions, startup import, staged changes, activation, and operation across replicas.

  • Query Language — Explains structured query conditions, field roots, nested matching, fragment filters, and authorization-filter interaction.

  • Shared Runtime Features — Describes runtime functionality implemented in shared BaSyx Go code and identifies where those features are available.

  • Observability — Covers common logging, request correlation, tracing, and PostgreSQL connection-pool metrics.

  • Pagination — Describes paged API responses, pagination parameters, and continuation cursors.

  • Conditional Requests — Explains ETags, cache revalidation, and protection against concurrent updates.

  • Validation and Verification — Describes model validation, verification behavior, and the handling of invalid resources.

  • Repository-to-Registry Integration — Describes how repositories can create, update, and remove corresponding descriptors in registries.

  • Asynchronous API Operations — Describes the API operations that BaSyx Go provides asynchronously and how their results are retrieved.

  • Response Representations — Explains the supported AAS response representations, including normal, $value, $metadata, $reference, and $path.

  • Recent Changes, History, and Signed Reads — Covers recent-change queries, historical states, integrity and mutation evidence, and cryptographically signed reads.

  • History Evidence Verifier — Explains how to verify and recover supported history, mutation, and ReBAC audit evidence.

  • Relationship-Based Access Control (ReBAC) — Describes experimental owner-managed resource sharing with users and groups alongside ABAC.

  • Eventing — Describes experimental CloudEvents-based change notifications and their REST, MQTT, Kafka, and AMQP delivery options.