#1001 Add a comment to fields used by shields.io

[ericmoritz]

Fix for #1001. I guessed on the formatting of the comment. I can easily change it if needed.

[sgrif]

I'm not really sure that we need to specifically mark fields used by one client. We shouldn't be making any backwards incompatible changes to our API, as it is versioned and we know folks rely on it. (I'm not sure what specifically happened with #1001, I would guess that it never worked until it was fixed).

However, that issue has been open for a year so I'll defer to @carols10cents

[Turbo87]

@sgrif I believe #787 is the PR that introduced the problem

[ericmoritz]

@sgrif I won't mind if we close this PR. I was bored last night and grabbed a low hanging fruit.

[carols10cents]

I'm not really sure that we need to specifically mark fields used by one client.

We already mark the routes that cargo uses; this doesn't feel much different.

We shouldn't be making any backwards incompatible changes to our API, as it is versioned and we know folks rely on it.

Mistakes happen, we haven't documented the requests that our frontend uses, and we have been known to say "oh we're the only one using this, we can change it" and then been wrong.

I like this change. Thank you @ericmoritz !!

bors: r+

[bors-voyager]

Build succeeded

• continuous-integration/travis-ci/push