Skip to content

Latest commit

 

History

History
26 lines (23 loc) · 2.65 KB

README.md

File metadata and controls

26 lines (23 loc) · 2.65 KB

Architecture decision records

An ADR records why a design was chosen. Read the ones that touch your change before proposing a design, and do not re-propose a rejected design without new information. ADRs are history: never rewrite a decision. A later decision supersedes or amends it, and both Status lines say so. The current behaviour is in docs/spec.md.

Add a record by copying 0000-template.md when a change adds an extension point, changes the shape of public API, adds a dependency or changes a module boundary.

ADR Decision Status
0001 Record decisions as ADRs in this folder accepted
0002 Package layout and toolchain: Swift 6.2, strict concurrency accepted; dependency and logging parts superseded by 0009, product and Linux parts by 0011
0003 One error type, PassportError, classified by the OAuth error code accepted
0004 Expose the granted scope; an acceptance policy decides before a token becomes current accepted
0005 Operations that send the refresh token run one at a time accepted; amended by 0007
0006 Durations on an injected clock, not instants accepted
0007 Ordered store changes, a lane per session, revocation of the newest token accepted; amended by 0015
0008 Public API conventions: open structs for growing sets, factories, labels, Duration, Secret accepted
0009 Which external dependencies are allowed and how they are chosen accepted; amended by 0011
0010 swift-http-types is the HTTP currency type accepted; amended by 0011
0011 Apple platforms only: one module, CryptoKit, macOS 14 and iOS 17 accepted
0012 Endpoints must be https; loopback http needs the explicit allowsInsecureLoopbackEndpoints opt-in accepted
0013 The authorization code flow requires a configured issuer, so iss is never accepted unchecked accepted
0014 beginSignOut returns once local state is cleared, with a PendingSignOut to await the delete and the revocation accepted
0015 An exchange the server answered returns its token even if the session ended meanwhile accepted