optic

Hey all! New minor release, new feature: now you can edit individual fields, setting a description and parameters such as "optional" or "null". You can also remove fields that were captured accidentally, or are being retired. On any endpoint documentation page, click the field to see your options:

This works for query parameters as well. We've also included a fix for api exec (hat tip to @silentninja) and have included several documentation contributions as well. Thanks, all!

Changes

• Build FieldViewer component @niclim (#1117)
• Ecs ingest fix @silentninja (#1120)
• Fix install command @smizell (#1123)
• Handle polymorphic nested shapes @niclim (#1118)
• Query parameter field editing with shapeviewer @niclim (#1113)

🐛 Bug Fixes

• Fix bug where fields with unknown shapes can't be edited @JaapRood (#1125)

  yarn global add @useoptic/[email protected]

I'm pleased to announce another round of tweaks and fixes to make your Optic experience a bit smoother than ever. We've improved the API diff highlighting to reflect when query parameters are added, and we've improved our error reporting slightly. There's been some improvements behind the scenes as well to improve how we maintain Optic, to make sure we can get you the best features as quickly as possible.

• Fix/diff navigation prompting @niclim (#1097)
• Query param not showing up in endpoint changes @niclim (#1090)
• Fix cloud viewer from being able to reach edit mode @niclim (#1089)
• Handle array object fields being deleted @niclim (#1084)
• add browser only to main page @acunniffe (#1091)

  yarn global add @useoptic/[email protected]

10.2.3 is out - with some minor bug fixes and minor enhancements.

Changes

• make diff fingerprints portable @devdoshi (#1071)

🐛 Bug Fixes

• Raise errors when calling listDiffs and listUnrecognizedUrls @niclim (#1082)
• Fix so that optional now shows up in contributions list @niclim (#1081)

  yarn global add @useoptic/[email protected]

With this release comes a couple of bug fixes, including a bug with the changelog and deleted endpoints showing duplicated request / response bodies.

Changes

• Misc diff UI enhancements @niclim (#1047)

🐛 Bug Fixes

• Orphan spectacle endpoint nodes if not unique @niclim (#1056)
• Filter out removed request and response bodies based on batchCommit comparison @niclim (#1053)
• Fix bug where duplicate diffs are generated for unmatched optional primitive fields @JaapRood (#1049)

  yarn global add @useoptic/[email protected]

Fixes a few bugs, including deleted endpoints showing up and paths being incorrectly learnt in the diff flow.

🐛 Bug Fixes

• Fix spectacle returning removed endpoints @niclim (#1048)
• Fix paths being added when learnt, not staged @niclim (#1044)

  yarn global add @useoptic/[email protected]

It's a new minor version release, and with that comes a new feature: you can now document query parameters! Any traffic that comes through with query parameters will be automatically documented when learning new endpoints and resolving diffs, just like traffic bodies are documented today. We've also introduced several bug fixes, detailed below.

🚀 Features

• Query Parameters are now documented with captured traffic.
• updated navbar @acunniffe (#1009)

🐛 Bug Fixes

• Intercept: fix browser warning on Chrome, Windows @LouManglass (#1020)
• Fix bug where the UI could not interpret shape diffs with an optional inner shape trail @JaapRood (#1030)
• Add in redirects to diff flow @niclim (#1029)
• Prevent invalid interactions from generating diffs @niclim (#1017)
• Fix race condition diff @niclim (#1014)
• Fix diff trails @niclim (#999)
• fix: Use prod base domain when in prod, not the other way around @jshearer (#985)

  yarn global add @useoptic/[email protected]

Optic CLI 10.1.1 smooths out some rough edges and adds a few helpful features.

• The --verbose flag has been added to tasks and environments. When running api run start, for example, --verbose will print out useful setup , capture, and teardown information to help confirm your integration is working. This is intended to provide insights similar to api check for a task, inline, while it runs, to confirm the integration is fully working start to finish.
• Various reported issues, including colons (:) in a parameterized path element breaking unmatched URL learning.

Enjoy!

Changes

• Move diffs for capture state into redux @niclim (#977)
• Remove navigation from diffs -> docs on pending endpoint flow @niclim (#978)
• Remove unused spectacle queries and background components @niclim (#968)
• Add stricter typing to diff flow @niclim (#964)
• ingest: fixed exception on empty responses @LouManglass (#979)
• intercept: log the diff URI to the console (as well as open the browser) @LouManglass (#980)
• Hide reset to commit button for cloud viewer @niclim (#973)
• Move endpointChangelog into endpoint redux slice @niclim (#957)
• Update PathParameters panel to use the Panel component @niclim (#955)
• Refactor documentation page to use HttpBodyPanel @niclim (#954)
• Migrate endpoint bodies to redux @niclim (#948)
• Query connect spectacle to rust @niclim (#943)
• Pass exit status through from script @smizell (#947)
• Add test command as alias @smizell (#946)
• Handle content type null crashing diff flow @niclim (#940)
• Move discard endpoint on diff flow to recently added rows @niclim (#931)

🚀 Features

• verbose flag to replace api check @acunniffe (#945)
• feature: Show request method in coverage report @jshearer (#928)

🐛 Bug Fixes

• Remove shell script and replace with command @niclim (#975)
• Fix cannot read commands of undefined @niclim (#966)
• Fix approve all accepting all new region diffs @niclim (#962)
• Fix undocumented body not showing up in diff list @niclim (#960)
• Fix crash on the bulk learn modal @niclim (#961)
• Fix the todos partial changelog example @niclim (#959)
• Fix react fragment warning @niclim (#944)
• Change path parameter matcher to use a fn instead of pathToRegexp lib @niclim (#942)

  yarn global add @useoptic/[email protected]

The release of 10.1.0 brings with it some exciting new features:

• Delete Endpoint When editing the documentation in the UI, you can now delete a documented endpoint.
• Spec Sharing and Open Source Badges Want to share your specification? The new Share feature lets you host a copy of your documentation for easy distribution. It also provides a badge showing your endpoint count that will link to your documentation, suitable for embedding in your project's README.
• History/Reset to Commit If you need to roll back to an earlier version of your documentation, the history tab allows you to reset to a previous commit and undo a set of spec changes.

Changes

• Move discard endpoint on diff flow to recently added rows @niclim (#931)
• style: Uniformly style the share button @jshearer (#930)
• Turn on reset to commit FF @niclim (#927)
• Only show share button when on docs page @jshearer (#924)
• Enable Deleting of Endpoint for all release environments @JaapRood (#923)
• Remove endpoint delete debug command @niclim (#921)
• Fix sourcemap upload @niclim (#915)
• Spectacle typings @niclim (#912)

🚀 Features

• feature: Show request method in coverage report @jshearer (#928)
• Add in confirm reset modal and hook up UI to spectacle @niclim (#919)
• Implement reset to commit spectacle commands @niclim (#914)
• Implement a basic History page UI @JaapRood (#918)

🐛 Bug Fixes

• Fix lint error @niclim (#925)
• Fix double enter press when confirming change @niclim (#922)
• Fix UI gql queries @niclim (#920)

  yarn global add @useoptic/[email protected]

Changes

• Pass errors onto sentry for network calls @niclim (#901)
• Use spectacle path parameters for path grouping @niclim (#900)
• New fields, within objects, inside of lists [BREAK] -> Do not break @acunniffe (#902)
• Add support for merging base OpenAPI documents into the generated one @smizell (#894)
• The missing pieces of a Design First approach @smizell (#891)
• Add specId to user saved doc changes event @niclim (#890)
• Revive debugOptic and update error page @niclim (#887)
• Fix example sessions @niclim (#889)
• refactor: Change paths to include personId @jshearer (#864)

🚀 Features

• Update spectacle projections to handle endpoint deletion @niclim (#876)
• Handle endpoint removal in changelog @niclim (#878)
• Ingest capture method @acunniffe (#898)
• Prune unused paths left after deleting endpoints @JaapRood (#869)

🐛 Bug Fixes

• Fix undelete from unstaging all endpoints @niclim (#877)
• Fix intercept mode not being able to diff @niclim (#909)
• fixed isCommandOnly logic @acunniffe (#908)
• Fix capture for context type text/html with no text body @niclim (#904)
• fix ecs test-case @acunniffe (#905)
• Prevent root node from being learnt multiple times @niclim (#903)
• Fix/common start issues @niclim (#893)
• Fix endpoint removal when endpoint is the last endpoint in the spec @niclim (#892)
• fix: Allow minor versions of tokio to be compatible. @jshearer (#884)

yarn global add @useoptic/[email protected]

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]

Changes

• Blog: Fix a broken link in the Git for APIs post @raybejjani (#662)
• docs: update setup link for blogs, help, tests @LouManglass (#659)
• workflows: retire bump.yml @LouManglass (#661)
• 9.0.19 @acunniffe (#660)
• Release 9.0.18 @acunniffe (#658)
• Bump y18n from 4.0.0 to 4.0.1 in /workspaces/agent-cli @dependabot (#649)
• specification.json merge (yarn.lock style) @acunniffe (#656)
• Enable Gitflow Capture in all builds @acunniffe (#655)
• Release 9.0.16 @acunniffe (#653)
• switch macos aarch64 build to stable rustup @notnmeyer (#652)
• docs: feedback on CLI page @LouManglass (#650)
• Refine Language @alexlmiller (#648)
• docs ported debug instructions into new troubleshooting page. @LouManglass (#647)
• (diff-engine): Allow events module to be accessed outside the crate @jshearer (#643)
• dependency bumps @LouManglass (#644)
• docs: added cli commands @LouManglass (#642)
• 9.0.15 @acunniffe (#641)
• chore: remain root user in devel container @notnmeyer (#640)
• command handlers should emit events for added contributions @acunniffe (#636)
• using target as hostnameFilter @acunniffe (#638)
• feat: support for building workspaces and diff-engine inside docker @notnmeyer (#639)
• Implement processing of spec commands for ExampleSpecService @JaapRood (#633)
• Fix for ignore @acunniffe (#634)
• flags: implement transparent proxy as a flag @LouManglass (#629)
• setup: added more useful reference, clarified documentation language @LouManglass (#626)
• Write EventContext for each event with new Rust command handler @JaapRood (#627)
• Oas generator should use listEvents path @acunniffe (#621)
• documentation: added Usability-tests.md @LouManglass (#605)

🚀 Features

• Move learning of initial request and response bodies to Rust @JaapRood (#645)
• oclif: add plugin-not-found / do you mean... @LouManglass (#654)
• feature: Implement s3 ingest capture saver @jshearer (#646)
• Allow persistence to a single or multiple spec change files through Rust @JaapRood (#623)

🐛 Bug Fixes

• invalid regexes should not crash daemon @acunniffe (#635)
• Fix bug where commit messages of batches would contain escape characters @JaapRood (#628)

  yarn global add @useoptic/[email protected]

Changes

• fix release process @notnmeyer (#624)
• Release 9.0.12 @acunniffe (#622)
• website: fix broken links @LouManglass (#619)
• Implement persisting new spec changes as batch commits in their own files in Rust @JaapRood (#612)
• updated careers page @acunniffe (#618)
• temp utility for deleting endpoints @acunniffe (#616)
• fix: update regerssion suites workflow to cross-compile diff-engine @notnmeyer (#617)
• docs: added integrations @LouManglass (#610)
• rm PoC gha workflows with task @notnmeyer (#614)
• feat[diff-engine]: build macos aarch64 from macos 10.15 @notnmeyer (#613)
• feat: add missing parts of our side-channel release process @notnmeyer (#606)
• Exp update notifier @LouManglass (#607)
• Add @batisteo as a contributor @LouManglass (#609)
• Docs: Fix the yarn command in the Readme @batisteo (#608)
• feat: one-off npm package builds to s3 @notnmeyer (#602)
• build tooling should have tools to make one-off artifacts simple @devdoshi (#604)
• 9.0.11 @acunniffe (#601)
• update ui snapshots @acunniffe (#600)
• debug logs verbosity increased @LouManglass (#489)
• platform: version info @LouManglass (#591)
• domain conflicts should be surface-able @devdoshi (#594)
• docs init: updated documentation, init help, for Windows @LouManglass (#592)
• fix: don't exit 1 when the env file doesnt exist @notnmeyer (#598)
• export should be quoted for extra safety @devdoshi (#597)
• sourceme should not leak env @devdoshi (#595)
• PowerShell doc tip @jordaniza (#580)
• don't build UI on PRs @notnmeyer (#590)
• feat: taskify regression workflow @notnmeyer (#573)
• Contributors @LouManglass (#587)
• chore: dont run the release workflow needlessly @notnmeyer (#575)
• rm cleans @notnmeyer (#586)
• add jordaniza as contributor for docs @LouManglass (#585)
• Some proposed suggestions for flask @jordaniza (#579)
• blog: intellij post @LouManglass (#572)
• Fix ignore confusion @acunniffe (#583)
• Add Rust diff engine developer setup @svanderbleek (#576)
• docs and cli: added advanced configuration (ignore), new ignore default) @LouManglass (#577)
• add careers page to website @acunniffe (#581)
• docs: swap cpp language utilities for lithium framework @LouManglass (#571)
• Report regression suite status to slack @notnmeyer (#569)

🚀 Features

• Implement Spec Loader that can produce single event stream from spec changes distributed in multiple files @JaapRood (#574)

🐛 Bug Fixes

• Fix for optional field interpreters @acunniffe (#615)

  yarn global add @useoptic/[email protected]

Changes

• build linux binaries with musl libc @notnmeyer (#567)
• update doc links printed in errors. @acunniffe (#566)
• setup: swapped Lithium for generic C++ instructions @LouManglass (#553)
• Fix some typos in Readme.md @autarch (#559)
• rm gha branch debug stuff @notnmeyer (#564)
• fix: point apidocs' api_url to prod until this becomes env-aware @notnmeyer (#563)
• feat: task/dockerize apidocs @notnmeyer (#558)

  yarn global add @useoptic/[email protected]

Changes

• fix: during gha docker build workflows select branch names based on the triggering gh event @notnmeyer (#562)
• Release 9.0.9 @acunniffe (#561)
• added websocket passthrough for forwarding proxy @acunniffe (#560)
• avoid running app ci workflows when unrelated things are changed @notnmeyer (#557)
• pull request template @notnmeyer (#550)
• build demo when merging to develop @notnmeyer (#549)
• chore: rm featurepeek @notnmeyer (#554)

🐛 Bug Fixes

• fix: sanitize git branch name for use in docker image tags @notnmeyer (#556)

🧰 Maintenance

• Upgrade diff-engine to Tokio v1 @JaapRood (#555)

  yarn global add @useoptic/[email protected]