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.

Sign up for GitHub

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

Jump to bottom

Update CONTRIBUTING.md with additional requirements for API additions #25639

Closed
andypiper opened this issue Jun 29, 2023 · 3 comments
Closed

Update CONTRIBUTING.md with additional requirements for API additions #25639

andypiper opened this issue Jun 29, 2023 · 3 comments
Assignees
@andypiper
Labels
api REST API, Streaming API, Web Push API

Comments

@andypiper
Copy link
Member

Pitch

Add information to CONTRIBUTING.md to specify that additions and updates to the API should also have an accompanying PR against the documentation.

Motivation

This will help to reduce the chances for the API endpoints to be undocumented as they are added.
@andypiper andypiper self-assigned this Jun 29, 2023
@andypiper andypiper added the api REST API, Streaming API, Web Push API label Jun 29, 2023
@ThisIsMissEm
Copy link
Contributor

The API docs aren't automatically generated, are they? Should we work towards having them auto-documenting?

@trwnh
Copy link
Member

trwnh commented Jul 1, 2023

no, they're not auto-generated, and it has been a historical challenge because there isn't an easy way to do so. in particular, version history is especially difficult to keep track of.

@JakePaustian JakePaustian mentioned this issue Dec 8, 2023
Merged
@mjankowski
Copy link
Contributor

Resolved by #28274

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@andypiper andypiper

Labels
api REST API, Streaming API, Web Push API
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@mjankowski @ThisIsMissEm @renchap @andypiper @trwnh