Agama OpenAPI & Schemas

This repository hosts versioned OpenAPI specifications and JSON schemas for the Agama installer.

Important: All specifications and schemas in this repository are automatically generated from the main Agama codebase.

This repository is a distribution mirror and does not accept direct contributions. All changes, bug fixes, or improvements to the OpenAPI definitions, JSON schemas, or documentation must be made upstream in the main Agama repository.

Directory Structure

Specifications and schemas are organized by version or release branch:

• /nightly/: Generated from the latest master branch of Agama.
• /<version>/ (e.g., 16.1): Specifications and schemas corresponding to stable release branches.

Contents per Version

Each version directory contains:

• openapi.json / openapi.yaml: The primary OpenAPI 3.1 specification, referencing extracted standalone schemas in schemas/.
• openapi_full.json / openapi_full.yaml: Fully resolved, monolithic OpenAPI 3.1 specification containing all component schemas inline with no external file references.
• schemas/: Standalone JSON schemas (Draft 2019-09) extracted for validation targets:
  • config.schema.json: Schema for Agama autoinstallation profiles.
  • proposal.schema.json: Schema for installation proposals.
  • system.schema.json: Schema for system information.

Using the Schemas

Autoinstallation Profiles

You can reference the JSON Schema directly in your Agama profile (JSON or YAML) for editor auto-completion and validation:

{
  "$schema": "https://raw.githubusercontent.com/openSUSE/agama-openapi/master/nightly/schemas/config.schema.json",
  "product": {
    "id": "Tumbleweed"
  }
}

Validating OpenAPI Specifications

You can validate the OpenAPI specifications using tools such as openapi-spec-validator:

openapi-spec-validator nightly/openapi.json
openapi-spec-validator nightly/openapi_full.json