Skip to content
This repository has been archived by the owner on Oct 17, 2024. It is now read-only.

Improve client NewEvaluator documentation about prefix #9

Open
asdine opened this issue Sep 25, 2018 · 0 comments
Open

Improve client NewEvaluator documentation about prefix #9

asdine opened this issue Sep 25, 2018 · 0 comments
Labels
enhancement New feature or request
Milestone

Comments

@asdine
Copy link
Contributor

asdine commented Sep 25, 2018

It is not clear that the prefix parameter is only used to select a subset of rulesets from the server and store the paths of these rulesets as is in the ruleset buffer.
The client.NewEvaluator simply matches the following HTTP API:

GET /rulesets/some-prefix?list
GET /rulesets/some-prefix?watch

which returns rulesets and their absolute paths.

What is confusing is that some expect the buffer to contain the path stripped from the prefix.

This

some-ruleset

instead of this

/some/path/to/some-ruleset

Improve the docstring in order to remove this confusion.

@asdine asdine added the enhancement New feature or request label Sep 25, 2018
@asdine asdine added this to the v0.6.0 milestone Oct 17, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant