Skip to content

Commit 52266c3

Browse files
committed
Deprecate ADR-18 as we will not implement
Signed-off-by: R.I.Pienaar <[email protected]>
1 parent 09b9355 commit 52266c3

File tree

2 files changed

+18
-7
lines changed

2 files changed

+18
-7
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ This repository captures Architecture, Design Specifications and Feature Guidanc
3030
|[ADR-13](adr/ADR-13.md)|jetstream, client|Pull Subscribe internals|
3131
|[ADR-14](adr/ADR-14.md)|client, security|JWT library free jwt user generation|
3232
|[ADR-17](adr/ADR-17.md)|jetstream, client|Ordered Consumer|
33-
|[ADR-18](adr/ADR-18.md)|client|URL support for all client options|
3433
|[ADR-19](adr/ADR-19.md)|jetstream, client, kv, objectstore|API prefixes for materialized JetStream views|
3534
|[ADR-20](adr/ADR-20.md)|jetstream, client, objectstore, spec|JetStream based Object Stores|
3635
|[ADR-21](adr/ADR-21.md)|client|NATS Configuration Contexts|
@@ -150,6 +149,7 @@ This repository captures Architecture, Design Specifications and Feature Guidanc
150149
|Index|Tags|Description|
151150
|-----|----|-----------|
152151
|[ADR-15](adr/ADR-15.md)|deprecated|JetStream Subscribe Workflow|
152+
|[ADR-18](adr/ADR-18.md)|deprecated|URL support for all client options|
153153

154154
## When to write an ADR
155155

adr/ADR-18.md

+17-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,22 @@
11
# URL support for all client options
22

3-
| Metadata | Value |
4-
|----------|---------------------------|
5-
| Date | 2021-07-21 |
6-
| Author | philpennock |
7-
| Status | Partially Implemented |
8-
| Tags | client |
3+
| Metadata | Value |
4+
|----------|-------------|
5+
| Date | 2021-07-21 |
6+
| Author | philpennock |
7+
| Status | Deprecated |
8+
| Tags | deprecated |
9+
10+
## Deprecation Note
11+
12+
We discussed this among client authors and felt that we would not implement this for, among others, these reasons:
13+
14+
* Server lists holds many server urls but the client has just one set of options, UX allowing options on each seem sub optimal
15+
* These parameters could expose sensitive information in logs and more
16+
* Getting exact parity between all the clients would be hard, we would need to pick specific list of supported options but it would be forever churn to support more on all clients
17+
* It would be difficult to always do the right thing wrt priority, in some cases you would want the URL to set defaults, in others you would want the URL to override settings
18+
19+
Overall we recognise this would be useful but decided against it for now.
920

1021
## Motivation
1122

0 commit comments

Comments
 (0)