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.

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

Invalid $SRV.INFO example in README.md #1710

Closed
Aggtaa opened this issue Sep 4, 2024 · 1 comment · Fixed by #1720
Closed

Invalid $SRV.INFO example in README.md #1710

Aggtaa opened this issue Sep 4, 2024 · 1 comment · Fixed by #1720
Assignees
Labels
defect Suspected defect such as a bug or regression

Comments

@Aggtaa
Copy link

Aggtaa commented Sep 4, 2024

Observed behavior

As of commit 1eafa27, README.md in main branch at https://github.com/nats-io/nats.go/blob/1eafa27812eea44d7cfc0c5aeab970d660b83b75/micro/README.md gives an example of $SRV.INFO response, which lists an apparently invalid field subjects:

nats req '$SRV.INFO.EchoService.tNoopzL5Sp1M4qJZdhdxqC' ''

19:40:06 Sending request on "$SRV.INFO.EchoService.tNoopzL5Sp1M4qJZdhdxqC"
19:40:06 Received with rtt 282.375µs
{"name":"EchoService","id":"tNoopzL5Sp1M4qJZdhdxqC","version":"1.0.0","metadata":{},"type":"io.nats.micro.v1.info_response","description":"","subjects":["svc.echo"]}

Expected behavior

According to specs at
https://github.com/nats-io/nats-architecture-and-design/blob/main/adr/ADR-32.md#INFO the response example should use endpoints field, not subjects

Server and client version

https://github.com/nats-io/nats.go/blob/1eafa27812eea44d7cfc0c5aeab970d660b83b75/micro/README.md

Host environment

No response

Steps to reproduce

No response

@Aggtaa Aggtaa added the defect Suspected defect such as a bug or regression label Sep 4, 2024
@piotrpio
Copy link
Collaborator

piotrpio commented Sep 24, 2024

Hello @Aggtaa, thanks for creating the issue! I created a PR fixing response schema in micro/README.md, good catch!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
defect Suspected defect such as a bug or regression
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants