Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate ADR-18 as we will not implement #326

Merged
merged 1 commit into from
Feb 11, 2025
Merged

Deprecate ADR-18 as we will not implement #326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ This repository captures Architecture, Design Specifications and Feature Guidanc
|[ADR-13](adr/ADR-13.md)|jetstream, client|Pull Subscribe internals|
|[ADR-14](adr/ADR-14.md)|client, security|JWT library free jwt user generation|
|[ADR-17](adr/ADR-17.md)|jetstream, client|Ordered Consumer|
|[ADR-18](adr/ADR-18.md)|client|URL support for all client options|
|[ADR-19](adr/ADR-19.md)|jetstream, client, kv, objectstore|API prefixes for materialized JetStream views|
|[ADR-20](adr/ADR-20.md)|jetstream, client, objectstore, spec|JetStream based Object Stores|
|[ADR-21](adr/ADR-21.md)|client|NATS Configuration Contexts|
Expand Down Expand Up @@ -150,6 +149,7 @@ This repository captures Architecture, Design Specifications and Feature Guidanc
|Index|Tags|Description|
|-----|----|-----------|
|[ADR-15](adr/ADR-15.md)|deprecated|JetStream Subscribe Workflow|
|[ADR-18](adr/ADR-18.md)|deprecated|URL support for all client options|

## When to write an ADR

Expand Down
23 changes: 17 additions & 6 deletions adr/ADR-18.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
# URL support for all client options

| Metadata | Value |
|----------|---------------------------|
| Date | 2021-07-21 |
| Author | philpennock |
| Status | Partially Implemented |
| Tags | client |
| Metadata | Value |
|----------|-------------|
| Date | 2021-07-21 |
| Author | philpennock |
| Status | Deprecated |
| Tags | deprecated |

## Deprecation Note

We discussed this among client authors and felt that we would not implement this for, among others, these reasons:

* Server lists holds many server urls but the client has just one set of options, UX allowing options on each seem sub optimal
* These parameters could expose sensitive information in logs and more
* 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
* 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

Overall we recognise this would be useful but decided against it for now.

## Motivation

Expand Down