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

docs: please help #8002

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

docs: please help #8002

wants to merge 3 commits into from

Conversation

eliobischof
Copy link
Member

@eliobischof eliobischof commented May 24, 2024

Which Problems Are Solved

We have limited control over API docs generation.
This can cause misleading or even wrong API documentation that is hard to fix.
The problem at hand is the wrong representation of proto oneof fields in the request examples described in this PRs commit.

How the Problems Are Solved

As long as we don't have an easy fix for these problems or a better solution for generating the APIs in the first place, we describe the docs issues in a linkable page and ask the community for ideas.

Additional Context

Copy link

vercel bot commented May 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 24, 2024 7:45pm

Copy link

github-actions bot commented May 24, 2024

Thanks for your contribution! 🎉

Please make sure you tick the following checkboxes before marking this Pull Request (PR) as ready for review:

  • I am happy with the code
  • Documentations and examples are up-to-date
  • Logical behavior changes are tested automatically
  • No debug or dead code
  • My code has no repetitions
  • The PR title adheres to the conventional commit format
  • The example texts in the PR description are replaced.
  • If there are any open TODOs or follow-ups, they are described in issues and link to this PR
  • If there are deviations from a user stories acceptance criteria or design, they are agreed upon with the PO and documented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🧐 Investigating
Development

Successfully merging this pull request may close these issues.

correct examples in docs
1 participant