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

[Utils] List of possible filter_values would be helpful #65

Open
Rubix982 opened this issue Jul 15, 2021 · 4 comments
Open

[Utils] List of possible filter_values would be helpful #65

Rubix982 opened this issue Jul 15, 2021 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@Rubix982
Copy link
Contributor

It can be useful to tell the user what kind of filter_values are possible when dealing with filtering the value in `properties.

For example, in #1, we see filter_values as,

# list of values to filter for and keep -- update this if changing to traffic signs
filter_values = ['object--support--utility-pole','object--street-light']

But I was unable to find this list of filter_values in the API docs.

This is related to #27 as we can check if the filter values given are correct, and alert the user if they've passed in the wrong filter values, and even provide as the mechanism for help as discussed in the Discord Chat (I can't find the issue that was made for this?). This is similar to #48 , but in the context of a help function.

Help needed, @cbeddow

@Rubix982 Rubix982 added the help wanted Extra attention is needed label Jul 15, 2021
@Rubix982 Rubix982 self-assigned this Jul 15, 2021
@cbeddow
Copy link
Member

cbeddow commented Jul 15, 2021

The official list for now is under "traffic signs" and "point" here (points == map features in this context): http://web.archive.org/web/20210105003120if_/https://www.mapillary.com/developer/api-documentation/#traffic-signs
http://web.archive.org/web/20210105003120if_/https://www.mapillary.com/developer/api-documentation/#points

This exact list should migrate to the new API docs soon but I cannot predict exactly when. Does this help for now? Maybe a text file is best to use with a fallback to scraping the website that we can switch to when these are live on the web?

@Rubix982
Copy link
Contributor Author

I agree with the file idea, we can scrap it pretty easily and keep it for checking locally, then move to remote API checking when it's finished on the API's end.

@Rubix982 Rubix982 added the documentation Improvements or additions to documentation label Aug 11, 2021
@Rubix982
Copy link
Contributor Author

This would need to be shifted to the documentation as well.

@eneerhut
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants