Skip to content

Develop#171

Merged
gem-cp merged 5 commits into
mainfrom
develop
Jul 8, 2026
Merged

Develop#171
gem-cp merged 5 commits into
mainfrom
develop

Conversation

@gem-cp

@gem-cp gem-cp commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

This pull request makes significant improvements and clarifications to the OpenAPI specifications for both the Notification Service RS endpoint and the Zeta Guard Admin OOB interface. The main focus is on enhancing documentation, clarifying lifecycle and audit concepts, and improving operator guidance. The changes also introduce support for idempotent notification submissions and expand descriptions for API parameters and objects.

Notification Service RS Endpoint

  • Added detailed documentation on the notification history feature, clarifying that history is implemented and exposed by the Notification Service itself, and specifying when and how it is activated (A_29973, A_29974, A_29975A_29978). Also clarified the retention and privacy requirements for notification identifiers (A_29988).
  • Updated references to requirements for identifier storage, replacing A_NS_DEPLOY_01 with A_29957.
  • Introduced support for idempotent retransmission of notification submissions using the Idempotency-Key header, including new documentation and schema for this header (A_29988, A_29992).

Zeta Guard Admin OOB Interface

  • Improved and clarified lifecycle documentation, including a revised state diagram and more precise descriptions of veto, approval, and dual control. Removed draft standards section and enhanced endpoint descriptions for better operator understanding. [1] [2] [3] [4] [5] [6] [7] [8]
  • Expanded and clarified descriptions for parameters, request/response fields, and audit trail filtering, including new descriptions for query parameters and improved documentation for operator actions and audit logging. [1] [2] [3] [4] [5] [6]
  • Added or improved descriptions for OpenAPI schema components, including DeletionStatus, OobProof, OperatorRef, and DeletionRequest, to clarify their roles and required fields, and to ensure auditability and traceability of operator actions.

These changes greatly improve the clarity, auditability, and operational guidance for both APIs, making them easier for implementers and operators to understand and use.

  • Notification Service RS Endpoint:

    • Clarified notification history implementation and privacy/retention requirements.
    • Updated requirement references for identifier storage.
    • Added idempotent submission support via Idempotency-Key header.
  • Zeta Guard Admin OOB Interface:

    • Enhanced lifecycle, veto, and dual control documentation; improved endpoint and parameter descriptions. [1] [2] [3] [4] [5] [6] [7] [8]
    • Expanded OpenAPI schema component descriptions for better auditability and operator guidance. [1] [2] [3] [4] [5] [6] [7]

gem-cp and others added 5 commits July 8, 2026 10:02
…add new RS interface diagram

- Deleted the outdated notification service diagram (notification-service.puml).
- Introduced a new diagram (Abb-ZETA-Notification-Service-RS-Schnittstelle.puml) detailing the interface between the Resource Server and the ZETA Notification Service, including active channel queries and asynchronous push notifications.
@gem-cp
gem-cp merged commit b75a83c into main Jul 8, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant