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

Jump to bottom

Document that /agent/services supports ?ns and add to API client #9710

Closed
lkysow opened this issue Feb 4, 2021 · 3 comments · Fixed by #10462 or #10691
Closed

Document that /agent/services supports ?ns and add to API client #9710

lkysow opened this issue Feb 4, 2021 · 3 comments · Fixed by #10462 or #10691
Assignees
@blake
Labels
good first issue A well-defined bug or improvement with sufficient context which should be approachable for new contr theme/api Relating to the HTTP API interface type/docs Documentation needs to be created/updated/clarified

Comments

@lkysow
Copy link
Member

lkysow commented Feb 4, 2021

Feature Description

  1. The /agent/services endpoint supports namespaces but it's not documented (https://www.consul.io/api-docs/agent/service#list-services)
  2. The API client doesn't support passing in a query object: https://github.com/hashicorp/consul/blob/master/api/agent.go#L525
@lkysow lkysow changed the title Document that /agent/services supports ?ns and add to API client Document that /agent/services supports ?ns and add to API client Feb 4, 2021
@jsosulska jsosulska added theme/api Relating to the HTTP API interface type/docs Documentation needs to be created/updated/clarified good first issue A well-defined bug or improvement with sufficient context which should be approachable for new contr labels Feb 5, 2021
@mkeeler mkeeler mentioned this issue Mar 5, 2021
Closed
blake added a commit that referenced this issue Jun 23, 2021
@blake
docs: Add namespace parameters to /agent/service*
f037e30 
Document supported namespace parameters for /agent/service* API
endpoints.

Resolves #9710
@blake blake mentioned this issue Jun 23, 2021
Merged
@blake blake self-assigned this Jun 23, 2021
blake added a commit that referenced this issue Jul 20, 2021
@blake
docs: Add namespace parameters to /agent/service*
bd4fe94 
Document supported namespace parameters for /agent/service* API
endpoints.

Resolves #9710
blake added a commit that referenced this issue Jul 21, 2021
@blake
docs: Add namespace parameters to /agent/service*
da747c2 
Document supported namespace parameters for /agent/service* API
endpoints.

Resolves #9710
@lkysow
Copy link
Member Author

lkysow commented Jul 21, 2021

@blake does this fix the issue with the API client?

@blake
Copy link
Member

blake commented Jul 21, 2021

It does not. I'll file that as a separate issue so that we can track those updates separately from the docs changes.

blake added a commit that referenced this issue Jul 24, 2021
@blake
api: enable query opts on agent health and maintenance endpoints
3da2a42 
This PR adds support for setting QueryOptions on the following agent
API endpoints:

- /agent/health/service/name/:name
- /agent/health/service/id/:id
- /agent/service/maintenance/:id

This follows the same pattern used in #9903 to support query options
for other agent API endpoints.

Resolves #9710
@blake blake mentioned this issue Jul 24, 2021
Merged
@blake
Copy link
Member

blake commented Jul 24, 2021

@lkysow #9903 added the ability to specify the namespace on a few endpoints using the API client. I just opened #10691 to support specifying ns for the /agent/health/service/name|id/ and /agent/service/maintenance endpoints.

blake added a commit that referenced this issue Jul 30, 2021
@blake
api: Support QueryOptions on additional agent endpoints (#10691)
c919f2d 
Add support for setting QueryOptions on the following agent API endpoints:

- /agent/health/service/name/:name
- /agent/health/service/id/:id
- /agent/service/maintenance/:id

This follows the same pattern used in #9903 to support query options
for other agent API endpoints.

Resolves #9710
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@blake blake

Labels
good first issue A well-defined bug or improvement with sufficient context which should be approachable for new contr theme/api Relating to the HTTP API interface type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Milestone
No milestone
3 participants
@blake @lkysow @jsosulska