Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Control API

Versioned, auditable control surface for system governance across ControlPlane components.

Scope

  • API definitions (OpenAPI/JSON Schema) with strict versioning.
  • AuthN/AuthZ integration and audit logging.
  • Change-management workflows (review, apply, rollback).

Integration

  • Provide SDKs/clients and server stubs.
  • Backward-compatible evolution with deprecation policy.
  • Reference adapters to policy-engine and resource-controller.

Versioning

  • Semantic versioning per API version; changelog with migration guidance.
  • Clear support windows for deprecated endpoints.

Deliverables

  • Schemas, server skeleton, client stubs.
  • Conformance tests and example calls.
  • Operational guides for deployment and auditing.

Standalone Installation

go get github.com/navinBRuas/_ControlPlane/control-api

Usage

import "github.com/navinBRuas/_ControlPlane/control-api"

Configuration

No mandatory configuration. Optional settings are documented in the package code and examples.

Version

0.1.0 (see VERSION.md)

Changelog

See CHANGELOG.md.

License

Apache-2.0. See repo root LICENSE.