API-Dokumentation

OpenAPI · Swagger

Öffentliche, gastzugängliche REST-Endpunkte von Missale Online — liturgischer Kalender, Messtexte, Psalter und Vulgata Clementina. Alle JSON-Antworten sind nach Frappe-Konvention in { "message": … } verpackt. Die maschinenlesbare Spezifikation liegt unter /api/method/liturgia.api.openapi.

Ohne ausdrückliche Quellenparameter genügt die Sprache: Jede Textstelle verwendet die Primärquelle und bei einer Lücke die konfigurierte zweite Quelle. Fehlen beide, bleibt die Textzelle leer. Die Antwort nennt die tatsächlich verwendete Quelle. Ausdrückliche Quellenparameter wählen genau diese Ausgabe; Gäste erhalten nur veröffentlichte Texte.

Die Reihenfolge der Messe steht in mass_order als Folge von {part, sequence}. Mehrere Lesungen werden mit ihren Gebeten und Zwischengesängen verschränkt. form=short wählt an Quatembersamstagen die kurze Form; Standard ist long. available_forms nennt die zulässigen Formen. office_kind unterscheidet den Tag von seinem Messformular. Weitere Messen tragen in den Kalendereinträgen is_additional_mass=true; ihre Gebete sind keine Kommemorationen.

Schriftverweise in parts[].scripture enthalten weiterhin url und ref. Das optionale Array passages führt jede Teilstelle in ihrer Lesereihenfolge auf, einschließlich ausgelassener Verse und weiterer Kapitel. Jede Teilstelle enthält book, chapter, verse_start, verse_end, url und ref. Versgrenzen sind einschließlich; Psalmen verwenden die Vulgata-Zählung. Ohne passages bleibt der bisherige Verweis nutzbar. Unter get_day stehen diese Angaben in mass.

Gastantworten können zwischengespeichert werden. Angemeldete Vorschauen werden mit Cache-Control: private, no-store ausgeliefert und stehen nicht offline zur Verfügung.

Veröffentlichte Ressourcen mit content_release verwenden einen festen Textstand. content_rows enthält die vollständige Lesereihenfolge und den Übersetzungsstatus je Textstelle; Quellenfelder und noch nicht modellierte Zusatzangaben bleiben leer.