New Working Group: API Design Language

We have a large set of API docs across nearly all of our API endpoints. Due to the length of time that we’ve been writing these docs, number of different teams touching those docs, even the opinions of individual contributors, all with very little written standards, it’s amazing how cohesive the API docs are at this point.

We are spinning up a working group to help design an API “Design Language”. Basically, we wish to put forth a small set of standards on how we want to design our API. This is not to put a strangle on how endpoints should work, but rather have a standard that should answer the commonly asked questions / encountered problems with designing endpoints and documenting those endpoints for our API docs.

The goal is to make the API easier for all developers, whether they are creators or users of the API.

Slack channel is: #wg-api-design-lang. We have a 6-person working group, made up of representatives from each engineering team. Feel free to join to watch the action/progress, but also please funnel your suggestions, concerns, etc through your team representative