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

Define a convention for custom fields #35

Open
philipashlock opened this issue Jun 4, 2013 · 0 comments
Open

Define a convention for custom fields #35

philipashlock opened this issue Jun 4, 2013 · 0 comments

Comments

@philipashlock
Copy link
Member

While service definitions do provide a way to include custom fields with different kinds of service requests, there are many situations where new fields are needed in other parts of the specification. In many cases, these custom fields could be candidates for additions or revisions to the spec, so it may make sense to allow for them to help drive the spec forward.

However, there should be a clear distinction between fields which are defined in the spec and those that are custom or unique to certain situations. In order to do this, it would be beneficial to define a convention for naming these custom fields and for ensuring that clients can ignore them as needed.

Here's a good example of this from the !OpenStates API: http://openstates.org/api/#extra-fields

Discussion thread: http://lists.open311.org/groups/discuss/messages/topic/3HCsNqI75HgNqVYaMaxubQ

@ghost ghost assigned philipashlock Jun 4, 2013
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

1 participant