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

API Page Optional Parameters Formatting #2084

Closed
MattJ12 opened this issue Apr 30, 2020 · 2 comments
Closed

API Page Optional Parameters Formatting #2084

MattJ12 opened this issue Apr 30, 2020 · 2 comments

Comments

@MattJ12
Copy link
Collaborator

MattJ12 commented Apr 30, 2020

On the API page for each accessibility format type there is an optional parameters section. For the severity parameter, you can only pass an integer so it should just say severity=[int], not severity=[int|string]. Also, for the filetype parameter there should be square brackets around what parameter types you can pass like this: filetype=[string]. The filetype parameter used to be like this: filetype=csv|geojson but I think it makes more sense based on how the severity parameter is specified to just do filetype=[string] to convey the type, not content, of the parameter. Also, for the Access Attributes API in the paragraph describing optional parameters there should be a space before the start of the third sentence.

@MattJ12 MattJ12 added the API label Apr 30, 2020
@misaugstad
Copy link
Member

Ahh, when we were talking earler, I forgot that you can pass in "none" for the severity parameter to get labels that have no severity rating. So severity=[int|string] still makes sense. But you're right that switching to filetype=[string] should happen. Also yes the typo should be fixed :)

@misaugstad
Copy link
Member

closing via #2141

@misaugstad misaugstad mentioned this issue Jul 3, 2020
@misaugstad misaugstad mentioned this issue Sep 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants