Skip to content

ref(apidocs): dont make devs set private = True for apidocs #45660

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
Merged
merged 2 commits into from
Mar 13, 2023
Merged

ref(apidocs): dont make devs set private = True for apidocs #45660

merged 2 commits into from
Mar 13, 2023

Conversation

@JoshFerge
Copy link
Member

@JoshFerge JoshFerge commented Mar 10, 2023 •
edited
Loading

  • There was previously a push to make new API endpoints public, and we'd fail api docs tests if private wasn't set to true, or the endpoints were documented
  • This ended up not being super useful as most new endpoints are private / still in development / only for the UI, so it never made sense to make them public right away
  • This also caused a bunch of brittleness as we maintained an exclusion list for old endpoints.

This should improve default developer experience, remove some messiness in imports, and not have any affect on when we make APIs public.

will update our devdocs in a follow up PR.

@github-actions github-actions bot added the Scope: Backend Automatically applied to PRs that change backend components label Mar 10, 2023
@JoshFerge JoshFerge marked this pull request as ready for review March 10, 2023 21:43
@JoshFerge JoshFerge requested a review from a team March 10, 2023 21:43
@JoshFerge JoshFerge requested review from a team as code owners March 10, 2023 21:43
@JoshFerge JoshFerge requested a review from a team March 10, 2023 21:43
@JoshFerge JoshFerge requested review from a team as code owners March 10, 2023 21:43
@JoshFerge JoshFerge requested review from a team March 10, 2023 21:43
@JoshFerge JoshFerge requested a review from a team as a code owner March 10, 2023 21:43
@JoshFerge JoshFerge requested a review from a team March 10, 2023 21:43
@JoshFerge JoshFerge merged commit bed30ee into master Mar 13, 2023
@JoshFerge JoshFerge deleted the jferg/make-private-by-default branch March 13, 2023 16:43
@github-actions github-actions bot locked and limited conversation to collaborators Mar 29, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@evanpurkhiser evanpurkhiser evanpurkhiser approved these changes

Assignees

No one assigned

Labels

Scope: Backend Automatically applied to PRs that change backend components

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@JoshFerge @evanpurkhiser