@scalar/swagger-editor
Version:
an editor which is tailored to write OpenAPI spec
938 lines (587 loc) • 17.4 kB
Markdown
# @scalar/swagger-editor
## 1.0.2
### Patch Changes
- Updated dependencies [68cda2b]
- @scalar/themes@0.6.4
- @scalar/components@0.4.4
## 1.0.1
### Patch Changes
- Updated dependencies [bbbba1f]
- Updated dependencies [897990b]
- @scalar/components@0.4.4
- @scalar/themes@0.6.3
## 1.0.0
### Minor Changes
- 7fb8273: Migrate to @scalar/openapi-parser
### Patch Changes
- Updated dependencies [7fb8273]
- @scalar/use-codemirror@0.9.0
- @scalar/oas-utils@0.1.0
## 0.11.3
### Patch Changes
- cecf074: Migrate to oas utils for basic spec operations
- Updated dependencies [cecf074]
- @scalar/use-codemirror@0.8.10
- @scalar/oas-utils@0.0.4
## 0.11.2
### Patch Changes
- ddc9b17: fix: re-added moving the components css into js so importing the css file is no longer needed
- 775646a: fix: removed extra copy of vue from themes and some dependencies
- ef3a015: chore: update to typescript 5.4
- Updated dependencies [ddc9b17]
- Updated dependencies [775646a]
- Updated dependencies [ef3a015]
- @scalar/components@0.4.3
- @scalar/themes@0.6.2
- @scalar/use-codemirror@0.8.9
## 0.11.1
### Patch Changes
- Updated dependencies [4ef178f]
- @scalar/themes@0.6.1
- @scalar/components@0.4.2
## 0.11.0
### Minor Changes
- ad2b95a: fix: scope scrollbar styles
- ad2b95a: refactor: move reset component to themes package
### Patch Changes
- Updated dependencies [ad2b95a]
- Updated dependencies [ad2b95a]
- @scalar/themes@0.6.0
- @scalar/components@0.4.2
## 0.10.15
### Patch Changes
- 3b672cc: fix: revert css changes to components lib
- Updated dependencies [3b672cc]
- @scalar/components@0.4.2
## 0.10.14
### Patch Changes
- Updated dependencies [c5e8b13]
- @scalar/components@0.4.1
## 0.10.13
### Patch Changes
- 5bc2ebf: Add syntax highlighting back to codemirror
- Updated dependencies [407a3af]
- Updated dependencies [5bc2ebf]
- @scalar/components@0.4.0
- @scalar/use-codemirror@0.8.8
## 0.10.12
### Patch Changes
- Updated dependencies [5a94530]
- @scalar/use-codemirror@0.8.7
## 0.10.11
### Patch Changes
- Updated dependencies [6857b8d]
- @scalar/components@0.3.0
## 0.10.10
### Patch Changes
- Updated dependencies [51acf2c]
- @scalar/themes@0.5.10
- @scalar/components@0.2.6
## 0.10.9
### Patch Changes
- Updated dependencies [c103201]
- Updated dependencies [d2728c8]
- @scalar/components@0.2.6
- @scalar/themes@0.5.9
## 0.10.8
### Patch Changes
- 1669b27: chore: update dependencies
- 7ea052b: chore: remove some languages from CodeMirror
- Updated dependencies [1669b27]
- Updated dependencies [7ea052b]
- @scalar/use-codemirror@0.8.6
- @scalar/components@0.2.5
- @scalar/themes@0.5.8
## 0.10.7
### Patch Changes
- c6b95ca: chore: upgrade from Vite 4 to Vite 5
- Updated dependencies [c6b95ca]
- @scalar/use-codemirror@0.8.5
- @scalar/components@0.2.4
- @scalar/themes@0.5.7
## 0.10.6
### Patch Changes
- Updated dependencies [5b3f7d9]
- @scalar/themes@0.5.6
- @scalar/components@0.2.3
## 0.10.5
### Patch Changes
- 92a8b9f: chore: update dependencies
- Updated dependencies [92a8b9f]
- Updated dependencies [abfb086]
- @scalar/use-codemirror@0.8.4
- @scalar/components@0.2.3
- @scalar/themes@0.5.5
## 0.10.4
### Patch Changes
- cb8139e7: fix: rollback api client proxy and request changes
## 0.10.3
### Patch Changes
- Updated dependencies [d4fff0de]
- @scalar/use-codemirror@0.8.3
## 0.10.2
### Patch Changes
- Updated dependencies [f8650e4f]
- @scalar/use-codemirror@0.8.2
## 0.10.1
### Patch Changes
- dd6dd283: fix: expect a blob when fetching spec via proxy
- Updated dependencies [b1f3cb49]
- @scalar/use-codemirror@0.8.1
## 0.10.0
### Minor Changes
- 612431b4: Migrate model logic from codemirror component to hook
### Patch Changes
- Updated dependencies [612431b4]
- @scalar/use-codemirror@0.8.0
## 0.9.12
### Patch Changes
- 04c0bd9b: chore: remove unused dependencies
## 0.9.11
### Patch Changes
- 6da73708: feat: handle application/zip responses in the API client
- Updated dependencies [6da73708]
- @scalar/use-codemirror@0.7.22
## 0.9.10
### Patch Changes
- Updated dependencies [cd7afa70]
- @scalar/use-codemirror@0.7.21
## 0.9.9
### Patch Changes
- Updated dependencies [3d712d74]
- @scalar/use-codemirror@0.7.20
## 0.9.8
### Patch Changes
- 81543f42: chore: add support for Node 18
- Updated dependencies [81543f42]
- @scalar/use-codemirror@0.7.19
- @scalar/components@0.2.2
- @scalar/use-modal@0.2.3
- @scalar/themes@0.5.4
## 0.9.7
### Patch Changes
- 479a7e3e: fix: bumped @codemirror/state dependency
- Updated dependencies [479a7e3e]
- @scalar/use-codemirror@0.7.18
## 0.9.6
### Patch Changes
- 5ca138ee: - Removed activeBreadCrumb from api-client as its available in the slot
- Centralized navigation logic
- use proper anchor navigation instead of scrollIntoView, it will also be saved to history
- scrolling down will open the next section
- Updated dependencies [5ca138ee]
- @scalar/use-modal@0.2.2
- @scalar/themes@0.5.3
- @scalar/components@0.2.1
## 0.9.5
### Patch Changes
- 6cc43ab7: fix: reset body margin
## 0.9.4
### Patch Changes
- 6d777194: feat: release themes
- Updated dependencies [6d777194]
- @scalar/components@0.2.1
- @scalar/themes@0.5.2
## 0.9.3
### Patch Changes
- Updated dependencies [c171c9d9]
- @scalar/use-codemirror@0.7.17
## 0.9.2
### Patch Changes
- 0b66933d: fix: declare theme font for buttons and fix regressed font weight
## 0.9.1
### Patch Changes
- Updated dependencies [1c4f4c88]
- Updated dependencies [2d7e3e6e]
- @scalar/components@0.2.0
## 0.9.0
### Minor Changes
- 1972947f: chore: removed yjs and hocus pocus from swagger editor
## 0.8.4
### Patch Changes
- a1319e8b: Switched internal component library to use ScalarComponents instead
- Updated dependencies [a1319e8b]
- @scalar/components@0.1.0
- @scalar/use-codemirror@0.7.16
- @scalar/use-modal@0.2.1
- @scalar/themes@0.5.1
## 0.8.3
### Patch Changes
- f9bfa97: feat: add buttons to header for classic layout
## 0.8.2
### Patch Changes
- 4f2fcc3: refactor: simplify and expand css reset
## 0.8.1
### Patch Changes
- 98e01a2: fix: prevent css leakage from references reset
- c04c2ea: fix: move swagger editor title down to cover border
## 0.8.0
### Minor Changes
- f38bb61: chore: remove swagger editor tabs
### Patch Changes
- Updated dependencies [f38bb61]
- @scalar/use-modal@0.2.0
- @scalar/themes@0.5.0
## 0.7.11
### Patch Changes
- 2251ea5: chore: remove tableau example
## 0.7.10
### Patch Changes
- 35dffe4: chore: include @scalar dependencies in the bundle
- Updated dependencies [35dffe4]
- @scalar/use-codemirror@0.7.15
- @scalar/use-modal@0.1.9
## 0.7.9
### Patch Changes
- c3b215f: chore: no pinned peer dependency versions
- Updated dependencies [c3b215f]
- @scalar/use-codemirror@0.7.14
- @scalar/use-modal@0.1.8
- @scalar/themes@0.4.2
## 0.7.8
### Patch Changes
- 55246e5: chore: rewrite all package.jsons (including their prod, dev and peer dependency requirements)
- Updated dependencies [55246e5]
- @scalar/use-codemirror@0.7.13
- @scalar/use-modal@0.1.7
- @scalar/themes@0.4.1
## 0.7.7
### Patch Changes
- 1a2afb6: fix: set additional peer dependency versions
## 0.7.6
### Patch Changes
- 8e65ba9: fix: set codemirror peer dependency version
- 36761e4: feat: make the available tabs configurable
## 0.7.5
### Patch Changes
- b6552df: chore: externalize dependencies, optimize bundle size
- 04875a6: fix: remove empty content update deleting rendered refs
## 0.7.4
### Patch Changes
- 801f1b5: feat: improve getting started page
## 0.7.3
### Patch Changes
- ff81f70: refactor: move getting started example to GettingStarted component
- ff81f70: fix: don’t overwrite the CodeMirror content when collaborative editing is enabled
## 0.7.2
### Patch Changes
- f4681d5: feat: add yaml syntax highlighting
- c92a3a3: chore: don’t add heading ids to the rendered Markdown
- 48118ba: feat: add updateContent event to the ApiReference component
- dab853a: chore: remove unused dependencies
- Updated dependencies [f4681d5]
- Updated dependencies [dab853a]
- @scalar/use-codemirror@0.7.12
- @scalar/use-modal@0.1.6
## 0.7.1
### Patch Changes
- a7e6c25: fix: externalize remark/rehype dependencies to fix SSG builds
## 0.7.0
### Minor Changes
- 440815a: Add getting started to empty render area
### Patch Changes
- 509db1e: refactor: move all api reference refs and watchers to hooks
- a4f1b08: fix: switching documents with collaborative editing mode enabled
- Updated dependencies [b0835a2]
- Updated dependencies [509db1e]
- Updated dependencies [a4f1b08]
- @scalar/use-modal@0.1.5
- @scalar/use-codemirror@0.7.11
## 0.6.30
### Patch Changes
- 8e2e4e5a: fix markdown collisions + prefix the card name
## 0.6.29
### Patch Changes
- db24e103: hotfix: import spec from url
## 0.6.28
### Patch Changes
- 2f0b2f01: refactor: improve the data flow between the reference and the swagger editor
## 0.6.27
### Patch Changes
- a73ee9d8: fix typography on editor headings
## 0.6.26
### Patch Changes
- d5fccba9: add ai writer to swagger editor
## 0.6.25
### Patch Changes
- Updated dependencies [64f8a018]
- Updated dependencies [7c3091c6]
- @scalar/use-codemirror@0.7.10
## 0.6.24
### Patch Changes
- Updated dependencies [aa24dbe6]
- @scalar/use-codemirror@0.7.9
## 0.6.23
### Patch Changes
- d87566fd: refactor: new section components, new sidebar
- Updated dependencies [db7f5f57]
- Updated dependencies [d87566fd]
- Updated dependencies [8be53df2]
- Updated dependencies [4eaee866]
- Updated dependencies [06b46553]
- @scalar/swagger-parser@0.5.5
## 0.6.22
### Patch Changes
- 357a174d: feat: fix import URL, use proxy to fetch files
- 357a174d: feat: click on import url or upload file in getting started opens the modal/dialog now
- Updated dependencies [fd6cf1bb]
- @scalar/swagger-parser@0.5.4
## 0.6.21
### Patch Changes
- Updated dependencies [fd38deb0]
- @scalar/themes@0.4.0
## 0.6.20
### Patch Changes
- af4ec8d3: update discord links
- 749f2f3f: fix: initial swagger editor content is parsed
- Updated dependencies [af4ec8d3]
- @scalar/swagger-parser@0.5.3
- @scalar/use-codemirror@0.7.8
- @scalar/themes@0.3.11
## 0.6.19
### Patch Changes
- 1cbcabd7: lots of amazing fixes from when we missed last patch
- Updated dependencies [33604a1b]
- Updated dependencies [1cbcabd7]
- Updated dependencies [d7b12610]
- @scalar/swagger-parser@0.5.2
- @scalar/use-codemirror@0.7.7
- @scalar/use-modal@0.1.4
- @scalar/themes@0.3.10
## 0.6.18
### Patch Changes
- a7f776ba: fix: restore content from local storage
## 0.6.17
### Patch Changes
- eb0c3201: Lot's of small things + bigger temp fix for the multi content cards
- Updated dependencies [eb0c3201]
- @scalar/themes@0.3.9
## 0.6.16
### Patch Changes
- 3805e649: remove hover on active header tab
## 0.6.15
### Patch Changes
- Updated dependencies [be239745]
- @scalar/use-codemirror@0.7.6
## 0.6.14
### Patch Changes
- 99744358: feat: cache swagger editor content in local storage
- 3dd2574d: sidebar toggle not flex aligned + fix folder colors
## 0.6.13
### Patch Changes
- Updated dependencies [7b6c21e5]
- @scalar/use-modal@0.1.3
## 0.6.12
### Patch Changes
- 46142c0a: reference theme fixes
- Updated dependencies [46142c0a]
- @scalar/themes@0.3.8
## 0.6.11
### Patch Changes
- 727d7f47: make swagger editor tab state controllable via prop
- 727d7f47: add initial tab state prop to swagger editor
## 0.6.10
### Patch Changes
- Updated dependencies [1d02c811]
- @scalar/themes@0.3.7
## 0.6.9
### Patch Changes
- b76f4d1e: Reference search + some app hover states
- Updated dependencies [b76f4d1e]
- @scalar/use-codemirror@0.7.5
- @scalar/use-modal@0.1.2
- @scalar/themes@0.3.6
## 0.6.8
### Patch Changes
- Updated dependencies [4985562c]
- @scalar/use-codemirror@0.7.4
- @scalar/themes@0.3.5
## 0.6.7
### Patch Changes
- Updated dependencies [58af0623]
- @scalar/use-codemirror@0.7.3
## 0.6.6
### Patch Changes
- cd5f2685: codemirror colors + font fixes throughout app
- Updated dependencies [cd5f2685]
- @scalar/themes@0.3.4
## 0.6.5
### Patch Changes
- Updated dependencies [8823d7a1]
- @scalar/use-codemirror@0.7.2
## 0.6.4
### Patch Changes
- 5363374d: fix broken renderer for swagger editor
## 0.6.3
### Patch Changes
- 449305f4: marketing content section
- 3e912c75: getting started page design
- 048555c6: feat: add CHANGELOG.md to the package
- Updated dependencies [449305f4]
- Updated dependencies [3e912c75]
- Updated dependencies [048555c6]
- @scalar/use-modal@0.1.1
- @scalar/swagger-parser@0.5.1
- @scalar/use-codemirror@0.7.1
- @scalar/themes@0.3.3
## 0.6.2
### Patch Changes
- 75a69ba7: feat: add `theme` prop and improve theme support
- d6a10e1f: fix: no border for the buttons
- Updated dependencies [75a69ba7]
- Updated dependencies [75a69ba7]
- @scalar/themes@0.3.2
## 0.6.1
### Patch Changes
- b184bdf2: codemirror themeing and other theme fixes
- 8751c874: Fix background color not being applied below rendered references
- addd9fa2: feat: use `default` prefix for all CSS variables
- 2006aa43: fix: add CSS reset
- Updated dependencies [b184bdf2]
- Updated dependencies [3b1fec80]
- Updated dependencies [addd9fa2]
- @scalar/use-codemirror@0.7.0
## 0.6.0
### Minor Changes
- 87fda5af: chore: update dependencies
### Patch Changes
- ef080a26: chore: format package.json
- 45645710: feat: show number of connected users
fix: typo, use API reference without Yjs
chore: remove useSwaggerEditor, no more global state
- Updated dependencies [ef080a26]
- Updated dependencies [87fda5af]
- @scalar/swagger-parser@0.5.0
- @scalar/use-codemirror@0.6.0
## 0.5.6
### Patch Changes
- 81336114: add yjs support
- Updated dependencies [81336114]
- @scalar/use-codemirror@0.5.4
## 0.5.5
### Patch Changes
- Updated dependencies [068669b6]
- @scalar/use-codemirror@0.5.3
## 0.5.4
### Patch Changes
- Updated dependencies [ac492d94]
- @scalar/use-codemirror@0.5.2
## 0.5.3
### Patch Changes
- a0a1590f: feat: make list of global extensions reactive
## 0.5.2
### Patch Changes
- d51aebe5: chore: remove source files from packages
- Updated dependencies [d51aebe5]
- @scalar/swagger-parser@0.4.3
- @scalar/use-codemirror@0.5.1
## 0.5.1
### Patch Changes
- Updated dependencies [4165b251]
- @scalar/swagger-parser@0.4.2
## 0.5.0
### Minor Changes
- 0902d82c: \* feat: register custom CodeMirror extensions
- feat: configure a status text to show in the Swagger editor
- clean up: remove custom CSS to overwrite the CodeMirror themes
### Patch Changes
- 10498d9d: chore: add README
- 494083a0: add more information to the package.json
- Updated dependencies [0902d82c]
- Updated dependencies [10498d9d]
- Updated dependencies [494083a0]
- @scalar/use-codemirror@0.5.0
- @scalar/swagger-parser@0.4.1
## 0.4.0
### Minor Changes
- 5057e213: make npm packages public :-)
### Patch Changes
- Updated dependencies [5057e213]
- @scalar/swagger-parser@0.4.0
## 0.3.0
### Minor Changes
- b0f5221: manually releasing all packages to make sure the lastest version is on npm
### Patch Changes
- Updated dependencies [b0f5221]
- @scalar/swagger-parser@0.3.0
## 0.2.0
### Minor Changes
- a ton of fixes, new fastify plugin
### Patch Changes
- Updated dependencies
- @scalar/swagger-parser@0.2.0
## 0.1.16
### Patch Changes
- fix: Node polyfill issues (process undefined)
- Updated dependencies
- @scalar/swagger-parser@0.1.14
## 0.1.15
### Patch Changes
- add offline search and ui improvements
- add offline search, improve ui
- Updated dependencies
- Updated dependencies
- @scalar/swagger-parser@0.1.13
## 0.1.14
### Patch Changes
- feat: add a standalone version
- Updated dependencies
- @scalar/swagger-parser@0.1.12
## 0.1.13
### Patch Changes
- fix sidebar height issue
- Updated dependencies
- @scalar/swagger-parser@0.1.11
## 0.1.12
### Patch Changes
- Updated dependencies
- @scalar/swagger-parser@0.1.10
## 0.1.11
### Patch Changes
- Updated dependencies
- @scalar/swagger-parser@0.1.9
## 0.1.10
### Patch Changes
- Updated dependencies
- @scalar/swagger-parser@0.1.8
## 0.1.9
### Patch Changes
- fix incorrect font sizes
## 0.1.8
### Patch Changes
- css variable fixes and hocuspocusurl prop
- Updated dependencies
- @scalar/swagger-parser@0.1.7
## 0.1.7
### Patch Changes
- fix: mismatched variables
## 0.1.6
### Patch Changes
- fix: issues with empty responses, minor styling issues
- Updated dependencies
- @scalar/swagger-parser@0.1.6
## 0.1.5
### Patch Changes
- style: improve default style
- Updated dependencies
- @scalar/swagger-parser@0.1.5
## 0.1.4
### Patch Changes
- fix: externalize dependencies
- Updated dependencies
- @scalar/swagger-parser@0.1.4
## 0.1.3
### Patch Changes
- fix: add CSS file to swagger editor
- Updated dependencies
- @scalar/swagger-parser@0.1.3
## 0.1.2
### Patch Changes
- 7cd41bc: fix: point main entry to dist folder
- Updated dependencies [7cd41bc]
- @scalar/swagger-parser@0.1.2
## 0.1.1
### Patch Changes
- f46e320: Initial release 👀
- Updated dependencies [f46e320]
- @scalar/swagger-parser@0.1.1