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

Cadl doc preview support #111

Open
ruowan opened this issue Jan 3, 2023 · 3 comments
Open

Cadl doc preview support #111

ruowan opened this issue Jan 3, 2023 · 3 comments
Assignees

Comments

@ruowan
Copy link
Member

ruowan commented Jan 3, 2023

  1. Support doc preview for Cadl PR in spec repo
  2. Doc auto refresh v2 support cadl
@live1206
Copy link
Member

live1206 commented Jan 3, 2023

1 is supported already since swagger files are still kept in Cadl PR

@live1206
Copy link
Member

live1206 commented Jan 20, 2023

For 2, learned from SDK generation that, the entry Cadl file should import/reference to all needed Cadl files, so that the related services will be generated as well during compilation.
Need to test if Cadl compilation generates multiple swagger files from entry Cadl or just 1.
And also, there is no multiple versioning support for Cadl + Dpg, there is just 1 version including all API versions right now.

So, there is no way to rely on SDK version/tags like before with readme files, we can only rely on API versions with Cadl files.

@live1206
Copy link
Member

live1206 commented Feb 7, 2023

In conclusion, for Cadl + Dpg, we can only leverage API version since there is no SDK version anymore.
We will get latest/latest stable version from API version for Docs publish.
cc @josefree

@ruowan ruowan assigned konrad-jamrozik and unassigned live1206 and ruowan Mar 13, 2023
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

3 participants