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

Improve ApiDoctor beta error messages to be more actionable #43

Open
MIchaelMainer opened this issue Nov 12, 2019 · 1 comment
Open

Comments

@MIchaelMainer
Copy link
Collaborator

@millicentachieng

Needs better actionable error messages - the issue on the lead up to Ignite could have been fixed much earlier if the logs had better error messages. The issue was because of duplicate example ids but the error message didn't make that clear.

@Lauragra @angelgolfer-ms

If you find more issues with unclear ApiDoctor messages, please use this issue thread to capture that information. At some point this should reach a critical mass that we can fix these issues in one swoop.

@angelgolfer-ms
Copy link

@MIchaelMainer , @millicentachieng , I think it would be helpful for authors if API Doctor can allow examples in the same topic to refer to the same resource ID (in the SampleKeys attribute preceding the example request). There are scenarios where we would like to be able to show a series of examples in the same topic, referring to the same resource in the example requests.

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

No branches or pull requests

2 participants