temando / open-api-ui

[DEPRECATED] A visualiser for Open API definitions such as Swagger.

TEMANDO

Temando Magento plugin v1.7

open-api-ui's Issues

Remove 'Items' From Array Lists

Can we please have Swagger remove the items keyword where it exists in any array lists?

In JSON schema this is meant to describe what value we need, but our renderer does not ignore this, and so it's confusing for anyone consuming our Swagger doco.

This sample comes from POST /shipments.

http://canary-developers.temando.com.s3-website-us-east-1.amazonaws.com/definition-viewer/?url=https://s3.amazonaws.com/temando-swagger-registry-dmidwaffle-storage/swagger/temando-public-api.json#post-shipments

Support `anyOf` JSON Schema

The Open API v2 specification notably does not support anyOf (or oneOf #10).

However, Open API v3 does have full JSON Schema support via the content property. The format of the Swagger differs a little to accomplish this (requestBody.content/resources.{code}.content), which will be a separate ticket, but there's still pay it forward for us to be able to visualise the anyOf definitions.

Add loading state

Sometimes the Swagger files are quite large and it takes a little bit for the app to "react" before the user sees anything happening. Introducing a loading state would improve the UX of the application.
This could also address the "Download Swagger" button which is immediately visible and then shuffles around once the swagger is loaded.

RE: #5

Support Open API v3 `content`

The next version of Open API supports a content and contentType property.

Let's support this as part of an effort to support Open API v3 documents.

Improve default state.

If you load up this project without any URL defined you stare at a blank page. It'd be cool if we had a better page state instead. Perhaps even a modal with a input field that allowed you to specify the URL.

Handle element without a type

Currently elements without a type are ignored.

swagge schema spec does not specify that type is a mandatory field.

When a type is not specified for an element, it should be treated as string.

Interactive console

This is an epic. It would be amazing if there was the ability to send requests using this interface.

This could be a new tab under each endpoint and when selected it provides:

• Ability to set headers (required header key should be read from the Swagger)
• Ability to set URL parameters (likewise)
• Ability to set the body (be awesome if we could validate while we type, but that's a stretch goal)

When sending the request, it should then echo back:

• The response headers
• The response body

An in-range update of redux is breaking the build 🚨

Version 3.7.0 of redux just got published.

Branch	Build failing 🚨
Dependency	redux
Current Version	3.6.0
Type	dependency

This version is covered by your current version range and after updating it in your project the build failed.

redux is a direct dependency of this project this is very likely breaking your project right now. If other packages depend on you it’s very likely also breaking them.
I recommend you give this issue a very high priority. I’m sure you can resolve this 💪

Status Details

• ❌ continuous-integration/travis-ci/push The Travis CI build could not complete due to an error Details

---

Release Notes

v3.7.0

Another long break!

Oh, hey! I didn't see you sitting there. You look bored. How about a Redux release to spice things up?

Not a huge set of changes to report here. The biggest change, and the reason for the minor bump, is the UMD build is now done via Rollup. One big advantage is more readable code in the bundle. Rollup does "scope hoisting", which is a fancy term for putting every module at the top level of the file. Other than a surrounding IIFE, all of the code in Redux all lives together. You can compare the two here:

Rollup UMD build
vs
Webpack UMD build

There is also a cost savings of 30,811 vs 26,880 bytes, and 6,999 vs 5,995 bytes minified. Redux is already a small library, and this helps shave some extra bytes for our UMD users.

One thing to note is that Webpack has introduced it's own scope hoisting feature in 3.0 beta. So, this isn't intended as an indictment of Webpack. You should continue to use it in your own apps. The adage of "Webpack is for apps, Rollup is for libraries" definitely holds true. It still has a superior developer experience with hot module reloading and webpack-dev-server. But use whatever makes sense for your project, not just whatever we use. 😄

We're also looking at applying this to the NPM bundle. The main motivation is again more readable code in your bundles. Instead of transpilation oddities from Babel, you will end up with a single clean file, which should be easier to read through and debug. It's currently scheduled for the big, mythical 4.0 release and you can follow along in #2358

Changes

• Build UMD with rollup (#2283 by @TrySound)
• Warn when bindActionCreators encounters non-function property (#2279 by @artgillespie)
• Update variables to ES6 (#2169 by @dfrownfelter)
• Remove filtering inside compose (#2167 by @istarkov)
• Simplify compose (#2147 by @JoeCortopassi)

Commits

The new version differs by 309 commits.

• 2d229f0 3.7.0
• f3bba96 Removing the browser field for now
• f4d9e55 Upgrade all example deps, including the universal example to Webpack 2
• 2bc8f84 Upgrade some other deps
• 070b838 Upgrades and remove check-es3-syntax since Rollup breaks it always
• 1094724 Fix a typo in the Immutable.js docs (#2453)
• bf3a557 Fix redux-mock-store libdef for todos-flow (#2430)
• bf2b9b5 give redux-subscriber some attention in StoreSetup.md (#2433)
• 8b3e0cb syncing docs with recent PR (2431) (#2432)
• e238a19 'todo' const removal from reducers/todos.js (#2431)
• 0babfab Merge pull request #2429 from alexbaumgertner/bugfix/doc-link
• ae563c3 Fix link to ImmutableData article
• 383215a Update redux.js (#2428)
• c9ad6a4 Add 100% test coverage for todos-flow example (#2413)
• ea16d76 Fix eslint warnings, update react-scripts (#2420)

There are 250 commits in total.

See the full diff

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

---

Your Greenkeeper Bot 🌴

An in-range update of redux-logger is breaking the build 🚨

Version 3.0.3 of redux-logger just got published.

Branch	Build failing 🚨
Dependency	redux-logger
Current Version	3.0.2
Type	dependency

This version is covered by your current version range and after updating it in your project the build failed.

redux-logger is a direct dependency of this project this is very likely breaking your project right now. If other packages depend on you it’s very likely also breaking them.
I recommend you give this issue a very high priority. I’m sure you can resolve this 💪

Status Details

• ❌ continuous-integration/travis-ci/push The Travis CI build could not complete due to an error Details

---

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

---

Your Greenkeeper Bot 🌴

Support visualising of `enum` values

JSON schema and the swagger generated thereof lists values in Enums.
The swagger renderer should be able to display that to the reader so that, for example, if I'm looking at the Locations model, I can see all the valid types enumerated.
This might take the form of a display where an property that is based on an emum has a "Valid Values" field when rendered.

An in-range update of html-webpack-plugin is breaking the build 🚨

Version 2.27.0 of html-webpack-plugin just got published.

Branch	Build failing 🚨
Dependency	html-webpack-plugin
Current Version	2.26.0
Type	devDependency

This version is covered by your current version range and after updating it in your project the build failed.

As html-webpack-plugin is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

---

Status Details

• ❌ continuous-integration/travis-ci/push The Travis CI build could not complete due to an error Details

Commits

The new version differs by 12 commits .

• 61ec618 Release 2.27.0
• 9d7aa21 fix(chunksorter): webpack2 compatible (#569)
• cbbb4a9 Document yarn link before running tests (#570)
• 41dce56 Add link to html-webpack-include-assets-plugin (#560)
• 6dd753c Fix travis-ci: set tty size (#552)
• 7a781a4 Fix template compilation for es6 modules (#550)
• 1b4f8ef Fix template path resolving regexp to support loader query parameters (#542)
• 26c95e9 Update README.md
• 4509937 Update README.md
• d07d1eb updated README (#539)
• 2f4c883 Fix unit tests for node 0.12
• ecc0784 Fix unit tests for node 0.12

See the full diff.

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

---

Your Greenkeeper Bot 🌴

Add syntax highlighting for request/response

This would significantly improve the experience and readability of the content.

An in-range update of extract-text-webpack-plugin is breaking the build 🚨

Version 2.1.1 of extract-text-webpack-plugin just got published.

Branch	Build failing 🚨
Dependency	extract-text-webpack-plugin
Current Version	2.1.0
Type	devDependency

This version is covered by your current version range and after updating it in your project the build failed.

As extract-text-webpack-plugin is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Status Details

• ❌ continuous-integration/travis-ci/push The Travis CI build could not complete due to an error Details

---

Release Notes

Release v2.1.1

2.1.1 (2017-06-08)

Bug Fixes

• add a not null check for the content property before throwing error (#404) (58dd5d3)
• loader: rm unnecessary this.cacheable (caching) (#530) (c3cb091)
• don't extract from common async chunks (#508) (e595417)
• validation schema (schema-utils) (#527) (dfeb347)

Commits

The new version differs by 13 commits.

• 0271b39 chore(release): 2.1.1
• e595417 fix: don't extract from common async chunks (#508)
• a8ae003 chore(package): fix broken links && update devDependencies (#531)
• c3cb091 fix(loader): rm unnecessary this.cacheable (caching) (#530)
• eaa5236 docs: rm RELEASE.md (#532)
• 671e35e chore(package): update webpack-sources v0.1.0...1.0.1 (#526)
• dfeb347 fix: validation schema (schema-utils) (#527)
• d0e88d0 docs(README): add lead-in description (#517)
• 58dd5d3 fix: add a not null check for the content property before throwing error (#404)
• 6c50d8e Update README.md (#469)
• c63dc04 docs(README): clarify to set allChunks option when using CommonsChunkPlugin (#476)
• c40dc64 chore(package): reduce package size (#482)
• a284f3a docs(README): fix options table formatting (#478)

See the full diff

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

---

Your Greenkeeper Bot 🌴

Support `oneOf` JSON Schema

The Open API v2 specification notably does not support oneOf (or anyOf #9).

However, Open API v3 does have full JSON Schema support via the content property. The format of the Swagger differs a little to accomplish this (requestBody.content/resources.{code}.content), which will be a separate ticket, but there's still pay it forward for us to be able to visualise the oneOf definitions.

Handle error when loading swagger file

Currently, the system throws an alert when there is an issue with loading the swagger file, and the screen stays with the circle rolling.

It should display an error message on the screen, and redirect the user to the swagger input page.

Support Open API v3 `requestBody`

The next version of Open API adds a requestBody property which replaces the parameters.body in Open API v2.

Let's support this as part of an effort to support Open API v3 documents.

An in-range update of webpack-merge is breaking the build 🚨

Version 2.6.1 of webpack-merge just got published.

Branch	Build failing 🚨
Dependency	webpack-merge
Current Version	2.6.0
Type	devDependency

This version is covered by your current version range and after updating it in your project the build failed.

As webpack-merge is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

---

Status Details

• ❌ continuous-integration/travis-ci/push The Travis CI build could not complete due to an error Details

Commits

The new version differs by 3 commits .

• bf05fae 2.6.1
• 725b1c4 Update lib
• 814a219 fix - merge.smart should not merge rules that have differing enforce fields

See the full diff.

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

---

Your Greenkeeper Bot 🌴

Add ESLint to the project.

This project doesn't currently have any linting standards. We should add these to ensure that our contributions are consistent and make sense.
eslint-plugin-react seems to be the defacto, I don't know if this needs to be used in conjuction with airbnb base or what not.

Support displaying `allOf`

The Open API specification supports allOf, but the UI doesn't visualise this information correctly.

It will just show the parent property, but it doesn't know how to resolve the allOf property and visualise all properties underneath it.

Unable to resolve parameters with a `$ref`.

Open API supports a parameter being defined globally under a parameters property.

The current codebase seems to recognise this as shown here but it assumes that the parameters will be defined under the top level definitions property.

This is not the case. See attached
open-api-registry.yaml.txt for an example definition.

The resolving of ref's should be relative to the root Open API document.

An in-range update of babel-preset-env is breaking the build 🚨

Version 1.3.0 of babel-preset-env just got published.

Branch	Build failing 🚨
Dependency	babel-preset-env
Current Version	1.2.2
Type	devDependency

This version is covered by your current version range and after updating it in your project the build failed.

As babel-preset-env is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

---

Status Details

• ❌ continuous-integration/travis-ci/push The Travis CI build could not complete due to an error Details

Release Notes

v1.3.0

v1.3.0 (2017-03-30)

🐛 Bug Fix

• Add check for ArrayBuffer[Symbol.species] (#233) (@existentialism)

We now properly check for Symbol.species support in ArrayBuffer and include the
polyfill if necessary. This should, as a side effect, fix ArrayBuffer-related
errors on IE9.

💅 Polish

• Fill data with electron as a target. (#229) (@yavorsky)

We've simplified things by adding electron as a target instead of doing a bunch of
things at runtime. Electron targets should now also be displayed in the debug output.

• separate default builtins for platforms (#226) (@restrry)

If you are targeting the node environment exclusively, the always-included web polyfills
(like dom.iterable, and a few others) will now no longer be included.

📝 Documentation

• remove deprecated projects (#223) [skip ci] (@stevemao)

🏠 Internal

• npmignore: Add related to build data and codecov. (#216) (@yavorsky)

Commits

The new version differs by 8 commits .

• 8b2dc4f 1.3.0
• 6ebf857 Update changelog
• 046f326 Add check for ArrayBuffer[Symbol.species] (#233)
• aead61c Fill data with electron as a target. (#229)
• 48a329b separate default builtins for platforms (#226)
• a4d585c remove deprecated projects (#223) [skip ci]
• 88cbe17 Merge pull request #216 from babel/update-npmignore
• cf94af3 npmignore: Add related to build data and codecov.

See the full diff.

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

---

Your Greenkeeper Bot 🌴

An in-range update of mocha is breaking the build 🚨

Version 3.4.0 of mocha just got published.

Branch	Build failing 🚨
Dependency	mocha
Current Version	3.3.0
Type	devDependency

This version is covered by your current version range and after updating it in your project the build failed.

As mocha is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Status Details

• ❌ continuous-integration/travis-ci/push The Travis CI build failed Details

---

Release Notes

v3.4.0

Mocha is now moving to a quicker release schedule: when non-breaking changes are merged, a release should happen that week.

This week's highlights:

• allowUncaught added to commandline as --allow-uncaught (and bugfixed)
• warning-related Node flags

🎉 Enhancements

• #2793, #2697: add --allowUncaught to Node.js (@lrowe)
• #2733: Add --no-warnings and --trace-warnings flags (@sonicdoe)

🐛 Fixes

• #2793, #2697: fix broken allowUncaught (@lrowe)

🔩 Other

• #2778: Add license report and scan status (@xizhao)
• #2794: no special case for macOS running Karma locally (@boneskull)
• #2795: reverts use of semistandard directly ([#2648]) (@boneskull)

Commits

The new version differs by 9 commits0.

• 7554b31 Add Changelog for v3.4.0
• 9f7f7ed Add --trace-warnings flag
• 92561c8 Add --no-warnings flag
• ceee976 lint test/integration/fixtures/simple-reporter.js
• dcfc094 Revert "use semistandard directly"
• 93392dd no special case for macOS running Karma locally
• 4d1d91d --allow-uncaught cli option
• fb1e083 fix allowUncaught in browser
• 4ed3fc5 Add license report and scan status

false

See the full diff

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

---

Your Greenkeeper Bot 🌴

An in-range update of superagent is breaking the build 🚨

Version 3.4.1 of superagent just got published.

Branch	Build failing 🚨
Dependency	superagent
Current Version	3.4.0
Type	dependency

This version is covered by your current version range and after updating it in your project the build failed.

As superagent is a direct dependency of this project this is very likely breaking your project right now. If other packages depend on you it’s very likely also breaking them.
I recommend you give this issue a very high priority. I’m sure you can resolve this 💪

---

Status Details

• ❌ continuous-integration/travis-ci/push The Travis CI build could not complete due to an error Details

Release Notes

v3.4.1

• Allow retry() and retry(0) (Alexander Pope)
• Allow optional body/data in DELETE requests (Alpha Shuro)
• Fixed query string on retried requests (Kornel Lesiński)

Commits

The new version differs by 12 commits .

• 76690f1 3.4.1
• 7ba2ba2 Simplify check
• 25b2947 Merge pull request #1168 from popeindustries/master
• 649b6ee Dedupe query string append
• 80e1f14 default to 1 if no count or true; default to 0 if null/undefined
• fc1308a force negative count to 0
• 835fee1 validate retry() count and allow setting to 0
• 7d181f9 Merge pull request #1167 from alphashuro/patch-1
• 8fb1d9f Allow optional body/data in DELETE requests
• 3a95427 Merge pull request #1166 from kevinburke/fix-typo
• 66c34f4 Fix spelling mistake
• aa8f1ae Test body of GET requests

See the full diff.

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

---

Your Greenkeeper Bot 🌴

Deep link to Sections should update the hash on scroll.

Currently, you are able to deep link to different sections of the documentation using hashes, eg. #ContainerService.

Now, if you scroll the page you are able to notice that the navigation on the left side updates, but the hash never changes in the URL.

As a user, it would be a better experience if the URL hash updated as the page was scrolled.