-
Notifications
You must be signed in to change notification settings - Fork 697
Open
Labels
Description
Is your feature request related to a problem? Please describe.
For unfamiliar users, it's not clear what the possible allowed state enum values (such as 0, 1, or 2) represent. example.
Describe the solution you'd like
we could make it more readable by taking a leaf out of the http book, where both a code and human-readable text are returned. For example:
status_code: 200
status_text: SUCCESS
status_code: 404
status_text: NOT FOUND
{
"state": {
"foundRC": {
"status": {
"code": 0,
"text": "ALLOWED"
},
"path": "..."
},
"loadedRC": {
"status": {
"code": 2,
"text": "DENIED"
},
"path": "..."
}
}
}
This solution is preferred as it would remain self-documenting as the codebase evolves.
Describe alternatives you've considered
- document a human-readable description of all possible allowed states in
direnv --help
ordirenv status --help
- do nothing
xav-ie