search

bspk / oauth.xyz-site

MIT License
7 stars 5 forks source link

Param tense consistency #12

Open dmitrizagidulin opened 5 years ago

dmitrizagidulin commented 5 years ago

Two things:

1) The Request page first paragraph uses key singular, but the examples all use keys plural.

2) Speaking of tenses, the mix of plural and singular in the params (tho wholly understandable) is harder to remember. Would it be possible to just use the json-ld (and, I assume, multimode json) implicit convention of using singular only?

dmitrizagidulin commented 5 years ago

One other thing - the request has keys param, the response can return a key_handle (singular). Which, again, makes sense grammatically (keys_handle sounds weird), but the mismatch is harder to remember.

jricher commented 5 years ago

Thanks, the consistency is a fair point, and it's changed back and forth a couple times already so I'm not sure what's the best version. I'm not a fan of it being a singular term with multiple values, but that's not even what's really happening here with the keys. That is what's happening with resources though, so this will need to be considered there.