# Saxophone Society: Regeln für die öffentliche API

Diese Richtlinie gilt für die öffentliche REST-Auskunft unter /wp-json/saxsoc/v1. Sie beschreibt den vorgesehenen Umgang mit Änderungen ab ihrer Veröffentlichung.

## Versionen

Die Hauptversion steht im REST-Pfad: /saxsoc/v1. Die Versionsnummer im OpenAPI-Dokument bezeichnet den Stand des Plugins und ist von dieser Hauptversion zu unterscheiden. MCP und NLWeb verwenden eigene Protokollversionen, die in der Entwicklerdokumentation beschrieben sind.

## Kompatible Änderungen

Neue optionale Felder oder zusätzliche Endpunkte können innerhalb von v1 ergänzt werden. Clients sollen unbekannte optionale Felder ignorieren. Änderungen an aktuellen Programminhalten und Quellen sind Inhaltsaktualisierungen, keine neue API-Hauptversion.

## Inkompatible Änderungen und Abkündigung

Eine geplante Entfernung eines Endpunkts oder eines dokumentierten Felds sowie eine inkompatible Änderung seines Typs oder seiner Bedeutung erfordern eine neue Hauptversion. Solche Änderungen werden vor der Umstellung in der Entwicklerdokumentation mit betroffenem Endpunkt, Ersatz und vorgesehenem Umstellungstermin beschrieben. Es gibt keine pauschal zugesagte Mindestvorlaufzeit oder garantierte Parallelbetriebsdauer. Notwendige Sicherheitskorrekturen können kurzfristig erfolgen und werden dokumentiert.

Ein Abschalttermin wird erst genannt, wenn er feststeht. Deprecation- oder Sunset-Header werden nur gesetzt, wenn tatsächlich eine Abkündigung beziehungsweise ein Abschalttermin vorliegt. Aktuell wird mit dieser Richtlinie keine Abschaltung angekündigt.

## Zugang und Grenzen

Die öffentliche Auskunft liefert öffentliche Informationen. Auch die dokumentierten MCP- und NLWeb-Aufrufe führen keine Buchungen, Anmeldungen oder Käufe aus. Technische Grenzen und Fehlerantworten stehen in der Entwicklerdokumentation. Es gibt keine zugesicherte Verfügbarkeit oder persönliche Benachrichtigung über Änderungen.

* [Entwicklerdokumentation](https://marjanmarkelj.de/ki-dokumentation/)
* [OpenAPI](https://marjanmarkelj.de/wp-json/saxsoc/v1/openapi)
* Kontakt: info@marjanmarkelj.de