optic

Changes

• Handle redirects when visiting invalid URLs @niclim (#823)

🐛 Bug Fixes

• debug capture improvements @acunniffe (#840)
• Fix windows / linux scroll @niclim (#834)

yarn global add @useoptic/[email protected]

Changes

• ui: update instruction card @LouManglass (#830)
• Increase parallelism for file read to 3 @niclim (#825)

🐛 Bug Fixes

• Eliminate potential racing and performance issues in reloading spec projections from spec changes @JaapRood (#826)
• Misc type fixes and warning cleanup @niclim (#828)

yarn global add @useoptic/[email protected]

This marks the official launch of Optic 10, with major revamps across the board. Optic is faster than ever, with a shinier new UI. We've also introduced the Spectacle engine, allowing GraphQL queries against your specification.

Changes

• spectacle should rebuild projections when the spec changes @devdoshi (#822)
• Add spec id contribution to examples @niclim (#819)
• Add ignore rule helper tooltip @niclim (#821)
• Add specification ID @niclim (#816)
• Add typings to spectacle queries @niclim (#808)
• interaction-iterator: attempting to move to debugLogging @LouManglass (#813)
• scripts.ts: script name now required, offers scripts when match fails @LouManglass (#809)
• fix array polymorphism @niclim (#807)
• optic10 intercept flow @acunniffe (#722)
• verify.ts: check help was wrong, redundant for start task @LouManglass (#802)
• Fix ui snapshots @niclim (#800)
• refactor: Make absolutePathPatternWithParameterNames return / for the root path @jshearer (#782)
• Add cancel button on pending diff page @niclim (#797)
• Provide Spectacle URL as environment variable for scripts @smizell (#787)
• shapehash: Handle '{}' without crashing @raybejjani (#778)
• refactor: ci flag always implies coverage, exit code @jshearer (#776)
• Empty doc state @niclim (#766)
• shape-diff tests @acunniffe (#748)
• Update diff bulk mode flow @niclim (#761)
• Add support tool to extract raw OpticEngine streams from debug captures @JaapRood (#745)
• commands should include the client id and client session id @devdoshi (#759)
• Update openapi in CLI @smizell (#758)
• Initial OpenAPI support @smizell (#757)
• change component->render on react-router route @niclim (#756)
• Force local cli learn undocumented bodies to run sequentially @niclim (#750)
• Use relative link for changelog/documentation dropdown @niclim (#747)
• Fix load on diff page @niclim (#742)
• Pruning dead code @devdoshi (#726)
• Add typescript types to CQRS @niclim (#732)
• Remove text field error state when empty @niclim (#730)
• Fix infinite load on example @niclim (#716)
• fixed critical diff bugs @acunniffe (#710)
• Add default text to new endpoints page @niclim (#703)
• Add types to spectacle query + mutate @niclim (#704)
• Set pending contributions if component is remounted @niclim (#702)
• Fix next diff interactions when reviewing diffs @niclim (#705)
• Fix position sticky on TwoBodyColumn @niclim (#701)
• Fix webpack module resolution alias @niclim (#698)
• Local cli spectacle @acunniffe (#699)
• Expose shape -> commands over WASM bridge @acunniffe (#690)
• Update response resolver for requests query @smizell (#688)
• Add path ID, absolute path pattern with params, and more tests @smizell (#686)
• Add pathId to endpoint change query @acunniffe (#684)
• Implement Rust learners for InMemorySpectacle @JaapRood (#676)

🚀 Features

• Feature/coverage improvements @jshearer (#783)
• feature: Implement coverage calculation @jshearer (#760)
• Add was_empty_array and was_empty_array_trails to InteractionAffordances so UI can reason about not rendering empty array examples @JaapRood (#762)
• Add empty state to completed diffs @niclim (#717)
• Allow for user enter press on input fields @niclim (#711)
• Feature/add path parameters @niclim (#692)
• Add in commit messages on saving / accepting diffs through spectacle @niclim (#691)
• feature: Expose contributions projection to EndpointChanges @jshearer (#696)
• feature: Implement cloud spec viewer @jshearer (#674)
• Implement endpoint name contributions in diff flow @niclim (#682)
• Save + load contributions in Optic GUI @niclim (#678)
• refactor: Include pathId in response from generateEndpointChanges @jshearer (#685)
• Include convention for configuring various entrypoints + featureflags @acunniffe (#681)

🐛 Bug Fixes

• add UI for capture helper links @acunniffe (#818)
• Prevent shape commands / events to be generated for learned shape affordances not selected by the user @JaapRood (#724)
• intercept mode capture link @acunniffe (#817)
• Fix shape descriptor @niclim (#814)
• enable changelog on diff pages @acunniffe (#812)
• Fix/diff minor bugs @niclim (#815)
• Fix submit diff enter press @niclim (#810)
• Fix/field key from trails @acunniffe (#803)
• Fix bug where no Response would be learned for interactions without response bodies @JaapRood (#804)
• Fix author ignore rules component @niclim (#806)
• Fix ignore rules @niclim (#805)
• Fix some ui warnings @niclim (#801)
• Fix bug where undocumented body learner would miss certain optional fields @JaapRood (#788)
• fix invalid command to change root shape @acunniffe (#789)
• Add loading state to pending endpoints @niclim (#779)
• Only consider children with object parents as being able to be missing @JaapRood (#777)
• Fix bug where commands empty list is generated when array was only observed empty once @JaapRood (#775)
• fix path grouping on documentation page @niclim (#770)
• new endpoints should share path lineage @acunniffe (#765)
• Fix bug where shape diff affordances were aggregated for each instance, nstead of only the unique diffs @JaapRood (#768)
• correct api name now being used @acunniffe (#767)
• Handle no learning results from initial learn @niclim (#764)
• Fix bugs where shape diff affordances projection was incorrectly detecting missing fields @JaapRood (#752)
• Fix bug where Shape Diff Affordance learner would not generate affordances for missing fields @JaapRood (#751)
• Fix undocumented url disappearing when navigate away @niclim (#746)
• Fix generating of empty affordances for diffs of array items @JaapRood (#738)
• Remove timeout on navigation @niclim (#744)
• Add prompt away to diff workflow @niclim (#719)
• Sort endpoint responses by status code @niclim (#741)
• fix edit performance on documentation page @niclim (#740)
• style updates @acunniffe (#739)
• tempfix/shape rendering @acunniffe (#737)
• Fix/grouped endpoints @niclim (#727)
• Fix/busted diff engine build @notnmeyer (#731)
• Fix exports for insourced shape hash @acunniffe (#725)
• Fix bug where learned Shape Diff Affordances did not include affordances for nested values @JaapRood (#720)
• initial porting of ignore rules @devdoshi (#715)
• Handle long endpoint names on small screens add endpoints diff page @niclim (#718)
• Fix typing after merge @niclim (#709)
• updated links in local-cli @acunniffe (#706)
• added a jsontrail to the into_commands signature @acunniffe (#700)

yarn global add @useoptic/[email protected]

Changes

• enable pass-exit-code flag for tasks + test tasks @acunniffe (#668)
• command-session: change logging level @LouManglass (#673)
• Optic connectors @LouManglass (#679)

🚀 Features

• Move learning of diff trail affordances to Rust @JaapRood (#663)

yarn global add @useoptic/[email protected]

Changes

🐛 Bug Fixes

• fix for OAS Export

yarn global add @useoptic/[email protected]

Changes

No CLI changes - workflow updates in GitHub

yarn global add @useoptic/[email protected]

Changes

• ui-v2: log CLI version @LouManglass (#870)
• Create redux metadata slice @niclim (#862)
• Implement redux + migrate useEndpointsHook @niclim (#854)
• Rename Rust packages to better describe their intended purpose @JaapRood (#827)
• Split changelog page from docs page @niclim (#847)

🚀 Features

• Connect endpoint deletion commands to UI via spectacle @niclim (#866)
• Implement Commands Generator for deleting of Endpoint @JaapRood (#856)
• Disallow editing contributions when endpoint is staged for deletion @niclim (#863)
• Switch out contributions store with redux and connect delete endpoint @niclim (#858)
• Add UI elements for deleting endpoint on documentation page @niclim (#857)

🐛 Bug Fixes

• Fix pending endpoint documentation display @niclim (#861)
• Handle special characters in api names @niclim (#850)
• Fix spectacle typings from IBaseSpectacle -> IForkedSpectacle @niclim (#853)
• Fix safari path parameter editing @niclim (#846)
• fixing scroll on win/linux browsers @LouManglass (#845

yarn global add @useoptic/[email protected]

New Features:

• Design-by-example feature released. Try it live!

• New Overview Page
• Fixed bug where nested objects became type 'Any' in the diff

• Computed fields (supports Express JS Routers)
• New annotations DSL

Debugged Linux installer & server operation

• Created a separate mode for context
• Made (escape) key exit an unfinished task
• Fixed timeout bug

Optic now features a CLI as its primary interaction model. We're saying goodbye to the GUI & hello to a cross-platform interactive prompt.

Try it out with:
npm install optic-cli -g

• Support for Sync
• Capabilities updated for parity with Optic Markdown 1.0.0
• Performance Enhancements

New Features:

• Advanced Transformations fully supported.
• All Renders go through the same code generation pipeline now
• Object Literals can have generated code used as their values
• Knowledge graphs can now be serialized, sent to the client, and used to present dropdown options/autocompletions
• Markdown parsing caches for better performance

Bug Fixes:

• Fixed issues where Node/NPM install checks were showing on startup even if those programs were installed
• Fixed issues with Schema References not working for some version numbers

Change Log:

• Release documentation
• Added Socket Events to send Project Status for Agents (Used to display loading page and error states)
• Bumped supported optic-markdown to version 0.1.2
• Fixed issue where Optic didn't work if the App was located in a path with a space in it ie 'Developer/My Apps'
• Packaged Optic Markdown within .jar so it doesn't need to be installed separately.
• Optic node checks if a valid version of Node is installed before starting
• Optic Editor window loads faster and has correct title

Bug Fixes:

• Data directories weren't being created on first run causing most of Optic's internal functionality to fail. This was missed because in testing we didn't wipe all Optic files from our test devices.
• Issue that prevented Optic servers from shutting down after the host Mac App closed has been resolved