Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 22 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
# axme-conformance

**Conformance suite for the AXME platform.** This repository contains the canonical contract test suite that validates spec-runtime-SDK parity across all API families, lifecycle invariants, and enterprise-boundary guarantees.
**Conformance suite for the AXME platform.** Canonical contract test suite validating spec-runtime-SDK parity across all API families, lifecycle invariants, and enterprise-boundary guarantees.

> **Alpha** · Conformance surface is expanding alongside the API. Not all families have full coverage yet.
> Questions and conformance proposals → [hello@axme.ai](mailto:hello@axme.ai)
> **Alpha** - Conformance surface is expanding alongside the API. Not all families have full coverage yet.

---

## About AXME
[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)

AXME is a coordination infrastructure for durable execution of intents across services, agents, and humans.
Learn more at [github.com/AxmeAI/axme](https://github.com/AxmeAI/axme).
**[Docs](https://github.com/AxmeAI/axme-docs)** · **[axp-spec](https://github.com/AxmeAI/axp-spec)**

---

## Purpose

The conformance suite is the authoritative answer to: *"Does this implementation correctly implement the AXME protocol and public API contracts?"*
Authoritative answer to: *"Does this implementation correctly implement the AXME protocol and public API contracts?"*

It validates:
Validates:

- **API contract correctness** - request/response shapes, status codes, error semantics
- **Lifecycle invariants** - state machine rules, terminal-state immutability, transition ordering
Expand Down Expand Up @@ -50,45 +46,12 @@ axme-conformance/

## Conformance Traceability

The traceability map shows how conformance checks are anchored to spec families, runtime behaviors, and SDK methods.

![Conformance Traceability Map](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/platform/04-conformance-traceability-map.svg)

*Each check cell links a spec contract (from `axme-spec`) to a runtime behavior (tested against `axme-control-plane`) and an SDK binding (tested per SDK). Green = passing, yellow = partial, red = failing or not yet implemented.*

---

<details>
<summary><strong>Audit and Evidence</strong></summary>

Conformance results feed the audit trail. Every check run produces an evidence record that maps to the access control and policy enforcement layer.

![Audit Trail Map](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/intents/08-audit-trail-map.svg)

*Audit evidence is structured: which check ran, against which endpoint, with which actor identity, what the result was. Evidence records are stored in the CI artifact archive.*

</details>

---

## Schema Compatibility Checks

Schema governance checks validate that schema changes in `axme-spec` do not introduce backward-incompatible breaks for existing consumers.

![Schema Governance and Compatibility](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/protocol/04-schema-governance-compatibility.svg)

*The compatibility check compares the new schema against all previously registered consumer versions. A breaking change fails the gate and requires a new schema version.*

---
Each check links a spec contract (from `axp-spec`) to a runtime behavior and an SDK binding.

<details>
<summary><strong>Resume, Controls, and Policy Conflict Resolution</strong></summary>

The most complex conformance domain covers the three-way conflict between a `resume` call, an in-flight `controls` update, and a `policy` mutation arriving at the same instant.
<summary>Traceability map diagram</summary>

![Resume, Controls, and Policy Conflict Resolution](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/intents/11-resume-controls-policy-conflict-resolution.svg)

*Conflict resolution rules: `resume` wins over `controls` if the intent is in a terminal `WAITING_*` state. `policy_generation` CAS prevents concurrent `policy` mutations from stomping each other. All conflicts are recorded in the audit trail.*
![Conformance Traceability Map](https://raw.githubusercontent.com/AxmeAI/axme-docs/main/docs/diagrams/platform/04-conformance-traceability-map.svg)

</details>

Expand All @@ -114,7 +77,7 @@ AXME_GATEWAY_URL=https://your-gateway.example.com pytest

## Coverage Matrix

Coverage by API family: all D1 families (intents, inbox, approvals, webhooks) have full contract checks. Enterprise admin families (orgs, workspaces, service accounts, quotas) are covered. The `billing` family has schema contracts defined but no conformance checks yet - tracked for addition. Target for Alpha release: all D1 families at 100% pass rate.
All D1 families (intents, inbox, approvals, webhooks) have full contract checks. Enterprise admin families (orgs, workspaces, service accounts, quotas) are covered. Target for Alpha release: all D1 families at 100% pass rate.

---

Expand All @@ -124,28 +87,29 @@ A conformance check is considered passing only when it succeeds against:

1. The reference runtime (`axme-control-plane` staging)
2. All five SDK clients (Python, TypeScript, Go, Java, .NET)
3. The schema definitions in `axme-spec`
3. The schema definitions in `axp-spec`

---

## Related Repositories
## Related

| Repository | Relationship |
| | |
|---|---|
| [axme-spec](https://github.com/AxmeAI/axme-spec) | Source of truth for contracts being validated |
| [axp-spec](https://github.com/AxmeAI/axp-spec) | Source of truth for contracts being validated |
| Control-plane runtime (private) | Primary runtime under test |
| [axme-docs](https://github.com/AxmeAI/axme-docs) | Narrative documentation that conformance evidence supports |
| [axme-sdk-python](https://github.com/AxmeAI/axme-sdk-python) | Python SDK validated by this suite |
| [axme-docs](https://github.com/AxmeAI/axme-docs) | Narrative documentation |
| [axme-sdk-python](https://github.com/AxmeAI/axme-sdk-python) | Python SDK |
| [axme-sdk-typescript](https://github.com/AxmeAI/axme-sdk-typescript) | TypeScript SDK |
| [axme-sdk-go](https://github.com/AxmeAI/axme-sdk-go) | Go SDK |
| [axme-sdk-java](https://github.com/AxmeAI/axme-sdk-java) | Java SDK |
| [axme-sdk-dotnet](https://github.com/AxmeAI/axme-sdk-dotnet) | .NET SDK |

---

## Contributing & Contact
## Contributing

New conformance check proposals: open an issue with label `conformance-proposal`. See [CONTRIBUTING.md](CONTRIBUTING.md).

---

- New conformance check proposals: open an issue with label `conformance-proposal`
- Quick Start: https://cloud.axme.ai/alpha/cli · Contact: [hello@axme.ai](mailto:hello@axme.ai)
- Security disclosures: see [SECURITY.md](SECURITY.md)
- Contribution guidelines: [CONTRIBUTING.md](CONTRIBUTING.md)
[hello@axme.ai](mailto:hello@axme.ai) · [Security](SECURITY.md) · [License](LICENSE)
Loading