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.

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

feat(vscode): add openapi3 preview #6015

Open
wants to merge 53 commits into
base: main
Choose a base branch
from
Open

feat(vscode): add openapi3 preview #6015

wants to merge 53 commits into from

Conversation

archerzz
Copy link
Member

@archerzz archerzz commented Feb 14, 2025 •
edited
Loading

  • add command to preview the main.tsp of the selected tsp file
    • each main tsp can have its own preview panel
    • preview panel will auto-refresh when a tsp file is changed
  • if multiple swagger definition is generated, command will prompt users to select one
    • the selection will be kept until the preview panel is closed
  • swagger definition is generated to a temp folder
    • temp folders will be cleared on deactivation
  • a minimal version of tsp 0.65.0 is required to simplify implementation
  • due to vsce package not supporting pnpm, I have to copy swagger-ui-dist lib files into our source folder. So, add those files into ignore list of lint and format.

resolve #4858

Mingzhe Huang (from Dev Box) added 14 commits January 22, 2025 11:00
init check-in
ac13a8e
do not use tmp folder
8e9c36b
open preview panel only after swagger file is generated
5f4bba3
Merge branch 'main' into vscode/openapi-preview
64e14d8 
# Conflicts:
#	packages/typespec-vscode/package.json
#	packages/typespec-vscode/src/extension.ts
#	packages/typespec-vscode/src/types.ts
#	pnpm-lock.yaml
improve multiple swagger file selection ui
63492f3
use temp folder to host preview output
556e9db
Merge branch 'main' into vscode/openapi-preview
9166069 
# Conflicts:
#	pnpm-lock.yaml
fix pnpm not supprted in vsce package
f057599
fix command title
c202688
Check minimal version of compiler
84dd3f8
Merge branch 'main' into vscode/openapi-preview
baae442 
# Conflicts:
#	pnpm-lock.yaml
improve file selection error
e87fc7c
improve error handling
b5a1f69
add chronus change log
e224bde
@archerzz
Copy link
Member Author

I have to copy swagger-ui-dist libs instead of importing them as dependencies, because pnpm is actually not supported in vsce package.

@azure-sdk
Copy link
Collaborator

azure-sdk commented Feb 14, 2025 •
edited
Loading

All changed packages have been documented.

  • ✅ typespec-vscode
Show changes

typespec-vscode - feature ✏️

add openapi3 preview

@azure-sdk
Copy link
Collaborator

azure-sdk commented Feb 14, 2025 •
edited
Loading

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs 🛝 VSCode Extension

@RodgeFu RodgeFu added the ide Issues for VS, VSCode, Monaco, etc. label Feb 14, 2025
@archerzz
Copy link
Member Author

https://github.com/arjun-g/vs-swagger-viewer is not suitable as a dependent extension for previewing swagger, because it only exposes a load method, which doesn't fulfill our requirement:

  • We cannot get the panel instance, which means:
    • we don't know when the panel is closed
    • we cannot manually switch panel from background to front ground
  • It maintains an HTTP server internally, which means more runtime footprint

weidongxu-microsoft and others added 19 commits February 21, 2025 10:46
@weidongxu-microsoft
http-client-java, when codegen error, trace the stderr too (microsoft…
76d9c8f 
…#6054)

I forgot to trace stderr. For error in postprocess/customization, the
error log is on stderr.
@JoshLove-msft
Add details for C# emitter (microsoft#6052)
ac0b22d
@v-jiaodi @MaryGao
[@typespec/http-specs] Fixed paths in specs/routes (microsoft#6013)
2ec8fae 
fixes microsoft#5430

---------

Co-authored-by: Mary Gao <[email protected]>
@JoshLove-msft
Respect fully qualified namespace when matching (microsoft#6051)
2571810 
Fixes microsoft#4735
@jorgerangel-msft
refactor: rename ClientModelPlugin to ScmCodeModelPlugin (microsoft#6055
d3d8482 
)

fixes: microsoft#5848
@JoshLove-msft
Add additional options to readme (microsoft#6057)
53cc8d8
@timotheeguerin
Fix: StringTemplate type not supported in typespecValueToJson (micros…
266342e 
…oft#5937)

This should work as long as the template has a string representation.

fix [microsoft#5391](microsoft#5391)
@timotheeguerin
Add tests for includeTemplateDeclaration (microsoft#5894)
8b397be 
Add test to confirm that this
microsoft#5197 is not an issue
@JoshLove-msft
Add fully qualified names support for AddTypesToKeep (microsoft#6061)
df4f95b 
Fixes microsoft#4418
@JoshLove-msft
Delete out-dated doc (microsoft#6063)
59ff8bc 
This is replaced by the README.md file.
@timotheeguerin
Standalone ability to start local server (microsoft#6047)
72492cd 
fix microsoft#6016
@chunyu3
remove typespec extension out of preview model (microsoft#5900)
d67eb8c 
Fix microsoft#5899

- remove typespec extension out of preview model
@msyyc
[python] remove confusing words from docstring of models (microsoft#6070
1030b4a 
)

fix microsoft#6064
@JoshLove-msft
Avoid duplicate null check and fix null serialization property name (m…
56316b9 
…icrosoft#6066)

Fixes microsoft#6040
@markcowl
Fixes to enums, operation signatures (microsoft#5952)
7174976
@JoshLove-msft
Build emitter tests (microsoft#6089)
10883fc 
Fixes microsoft#6090

Include emitter tests in the build so we can catch compilation errors.
They are excluded from the tgz tested using `npm pack`.
update ordering of commands and menu items
69bf3ce
rename parseOpenApi3File to parseJsonFromFile and change error ha…
ab1889e 
…ndling logic
add selected file in the error log if it's available
ef3981c
@archerzz
Copy link
Member Author

List of changes since last review:

  • update ordering of commands and menu items according to comments
  • refactor parseOpenApi3File to make it generic
    • add a new parseOpenApi3File in the openapi3-preview.ts which handles UI specific logic
  • add selected file in the error logs if it's available

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timotheeguerin timotheeguerin timotheeguerin left review comments

@RodgeFu RodgeFu RodgeFu left review comments

@bterlson bterlson Awaiting requested review from bterlson bterlson is a code owner

@markcowl markcowl Awaiting requested review from markcowl markcowl is a code owner

@allenjzhang allenjzhang Awaiting requested review from allenjzhang allenjzhang is a code owner

@chrisradek chrisradek Awaiting requested review from chrisradek chrisradek is a code owner

@AlitzelMendez AlitzelMendez Awaiting requested review from AlitzelMendez AlitzelMendez is a code owner

@witemple-msft witemple-msft Awaiting requested review from witemple-msft witemple-msft is a code owner

@iscai-msft iscai-msft Awaiting requested review from iscai-msft

@tadelesh tadelesh Awaiting requested review from tadelesh

@srnagar srnagar Awaiting requested review from srnagar

@weidongxu-microsoft weidongxu-microsoft Awaiting requested review from weidongxu-microsoft

@haolingdong-msft haolingdong-msft Awaiting requested review from haolingdong-msft

@XiaofeiCao XiaofeiCao Awaiting requested review from XiaofeiCao

@m-nash m-nash Awaiting requested review from m-nash

@JoshLove-msft JoshLove-msft Awaiting requested review from JoshLove-msft

@jorgerangel-msft jorgerangel-msft Awaiting requested review from jorgerangel-msft

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
ide Issues for VS, VSCode, Monaco, etc.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Preview typespec with swagger-ui in vscode