-
Notifications
You must be signed in to change notification settings - Fork 183
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
[CADL API view] Improve CADL instructions for upload #5273
Comments
Another improvement could be to make it more obvious that a CADL or JSON file is accepted. It would be good if the whole screen didn't go to an error when the JSON API view token file is uploaded or the space is left empty. A more descriptive error could help in understanding what the problem is. Same thing happened when adding a revision, it was not immediately obvious that the dropdown should be used to be able to upload the CADL token file as a JSON. When the dropdown is set to In this case we decided to simply not choose a language to get the instructions or to upload since that seemed to be the problem. Initially we were unable to add a revision as well. |
Instructions as to what URL to use in the API view instructions section would also be appreciated. If the CADL is in PR, should it be a link to the main.cadl file in that PR? |
While working with a service partner recently it became clear that the instructions for uploading an APIView for CADL should be improved.
Suggested instructions:
cadl compile .\main.cadl --emit "@azure-tools/cadl-apiview"
The text was updated successfully, but these errors were encountered: