relnotes_swagger tools
- No longer fail when server does not include body/query parsing middleware
We will not default to body-parser and qs whenever these are not present Fixes #70
- Updated documentation and example for changes made for issue #70
- Attach the original response body to response validation errors
Fixes #110
- Performance enhancement for swagger-metadata parameter processing
Only run request processors once per-type instead of once per parameter
- Update response validation to take the default response into account
Fixes #99
- Preparing for 0.7.4 release
- v0.7.4
- swagger-converter: 0.0.5
- Update APIs to do full validation for Swagger 2.0 where necessary
Fixes #97
- Refactored Swagger 1.2 Specification tests for upcoming browser tests
- Interim commit to prepare for browser tests
- Create browser tests and integrate them into the Gulp cycle
Fixes #96
- Updated API documentation for error-first callback and the Error object
- Remove Node 0.11 from Travis for now
- Fix Quick Start documentation
Fixes #101
- Fix bug with local YAML file processing for CLI
- Fix issue where non-operations are processed as operations
- Refactor to have the list of known Swagger HTTP methods in one place
- Preparing for 0.7.3 release
- v0.7.3
- swagger-converter: 0.0.5
- Update upstream dependencies
- v0.7.2
- swagger-converter: 0.0.5
- fix typos
- Merge pull request #87 from apigee-127/fix-typos
fix typos
- Added Swagger 1.2 -> 2.0 converion to swagger-tools CLI
We are using swagger-converter for his feature
- Fixed minor reporting bug for nested errors
- Updated documentation for new convert CLI command
- Added a
Specification#convertAPI and updated CLI to use it - Updated API documentation for new convert API
- Made apiDeclarations optional for convert API/CLI
- "form" is not a valid "in" value for 2.0, the correct value is "formData"
- appease the lint overlords
- Merge pull request #89 from apigee-127/formdata-fix
"form" is not a valid "in" value for 2.0, the correct value is "formData"
- Add support for validating responses
Fixes #25
- Updated documentation for next request
- Prepare browser build for next release
- v0.7.1
- swagger-converter: 0.0.5
- Rewrite to support Swagger 2.0 references properly (and more...sorry)
As I rewrote nearly everything to support all JSON References, fixing a number of bugs along the way couldn't be avoided. (For example, to make sure we were processing all definitions/references, I had to implement support for 2.0 security.) I realize this is bad taste for software development, large code commits that add/fix multiple things, but due to the nature of this rewrite, it was unavoidable. I hope to avoid this in the future. Below are the noteworthy additions and fixes but please see the documentation and release notes for more detailed information: JSON References, internal and remote, work everywhere now All Specification APIs now require a callback since the underlying code can be asynchronous Specification#composeModel was renamed to Specification#composeSchema and it will generate real JSON Schemas instead of the fake ones before All middleware now require an initialization phase to validate the Swagger document(s) prior to starting the server swaggerMetadata middleware has changed the structure of
req.swaggerto support new 2.0 features and 1.2 fixes Fixes #27 Fixes #54 Fixes #55 Fixes #63 Fixes #65 Fixes #68 Fixes #69 Fixes #71 Fixes #73 Fixes #79 - Added tests for Specification#resolve.
- Resolve header parameters regardless of case
Fixes #82
- Merged swagger-security branch
Conflicts: middleware/index.js package.json test/test-module.js
- Added swagger-security middleware to 1.2
- Handle inner validation errors
Fixes #85
- Support path parameters that are not path segments
Fixes #72
- Updated documentation for new release
Also renamed Specification#composeSchema back to Specification#composeModel
- Fixed a typo in the Middleware documentation
- Updated example and example docs for new release
- Updated 2.0 example JSON
Found a bug with invalid references and fixed it
- Fixed the example sources to work with new release
- Support validating YAML files from the CLI
Fixes #75
- Support validating remote files from the CLI
Fixes #74
- Updated to latest swagger-ui
- Added release notes
- Updated browser builds for upcoming release
- v0.7.0
None
- support coffe script controllers
- Merge pull request #66 from Tyny/master
Support coffee script controllers
- Added a few TODO items and made helpers#toJsonPointer handle the tilde
- Refactored code to create validators to be in one place
- Added code coverage
- add swagger-security middleware
- add swagger-security middleware
- switch order of parameters, make secReq just the scopes
- make handlers async
- Switch to using an Error to communicate authorization failure information
- make jshint happy
- fix swagger version v1 vs v2 test
- v0.6.13
None
- Updated for upstream swagger-ui changes
- v0.6.12
None
- Validate array types have items properties
This should eventually be handld by schema validation: https://github.com/swagger-api/swagger-spec/issues/174 Fixes #62
- Adjust logic that adds self references for inline schemas
Fixes #61
- v0.6.11
None
- Updated all middleware to pass Errors downstream
Fixes #58
- v0.6.10
None
- Fix issue with browser's jjv version
- v0.6.9
None
- Do not resolve/validate remote model references
Fixes #52
- Update browser distribution for release
- v0.6.8
None
- Fix the CLI for upstream issue with commander.js
- Rebuild browser distributions
- v0.6.7
None
- Update swagger-ui with upstream changes
Fixes #49
- v0.6.6
None
- Fixed documentation about binary browser builds
- Document the 4 different builds in gulpfile.js
- Fixed bug in CLI, examples and Quick Start
CLI: JSON Pointer strings did not escape / examples and Quick Start: Swagger version in 2.0 documents is now a string
- Fixed CLI for previous commit
- v0.6.5
None
- Fixed Bower distribution
- v0.6.4
None
- Added binary browser distributions
- v0.6.3
None
- Refactoring to make browser build smaller
- More work to slim down the browser distribution
Using Bower for available dependencies (jjv, lodash, spark-md5 and traverse) Using browserify for the others (jjve)
- v0.6.2
None
- Updated the 2.0 schema with upstream changes
Updated the 2.0 spec metadata to include wordnik repo link instead of reverb Fixed #40
- Updated browser distribution for upstream schema changes
- v0.6.1
None
- Updated 'swagger-validator' to return a 400 without requiring an error handler
Fixes #37
- Updated the browser distribution for recent changes
- v0.6.0
None
- Updated bower.json to exclude examples directory
- First pass at adding a CLI
Fixes #2
- Updated README to reflect new CLI
- Updated CLI documentation for command help example
- Minor style change to CLI documentation
- Minor style change to CLI help examples
- v0.5.9
None
- Updated for upstream swagger-ui changes
- Added full examples for the QuickStart
Fixes #33
- Minor refactoring and added not to find examples
- v0.5.8
None
- Updated documentation
Documented that Swagger 2.0 documents need operation tags for Swagger UI
- Created a browser distribution
Fixed #22
- Fix Travis
- Updated browser distribution
- v0.5.7
None
- Updated test for swagger-validator
Ensure that an array of models as a request parameter is tested properly (1.2)
- Fixed typo in 'Quick Start' documentation'
- Fixed another typo in the 'Quick Start'
- Added 'swagger-ui' middleware for serving Swagger documents and Swagger UI
- Fixed a typo in the 'Quick Start'
- 0.5.6
None
- swagger-router now sets the 'Allow' header for 405 responses
Fixes #31
- First pass at more detailed documentation
Fixes #21
- Added Swagger 1.2 examples to documentation
- Updated middleware documentation
- First pass at a 'Quick Start' guide.
- Updated to Quick Start to document/reflect upstream bug
Swagger 2.0's JSON Schema file does not allow you to place constraints on primitive request parameters. This is a known bug in the Swagger 2.0 schema and is being fixed.
- Minor updates to the 'Quick Start' guide.
- Fixed a typo
- Updated 'Quick Start' to have a quick blurb about JSON Pointer syntax
- First pass at model validation for swagger-router
Fixes #18
- Updated middleware documentation to reflect model validation in swagger-router
- 0.5.5
None
- Fix problem where swagger-router would attempt to handle non-Swagger routes
- 0.5.4
None
- Updated 2.0 schema for upstream changes
- Added model composition to 1.2
- Added model validation to 2.0
The same (where appropriate) level of model validation from 1.2 is present in 2.0
- Added model composition to 2.0
- First pass inferred responses for mock mode
Also includes the next pass at model composition Fixes #15 Fixes #29
- swagger-router should return a 405 when mock mode is enabled but no operation
Fixes #26
- Updated the README for model composition stuff
- 0.5.3
None
- Fix Travis
- Fix Travis again
- Made duplicate API path check smarter
Path checks are no longer verbatim and check for equivalency Part 1 of issue #6
- Fix Travis
- Added validation checks for missing/unresolvable API/operation path parameters
Fixes issue #6
- 0.5.2
None
- Fixed package.json to have proper project URLs and updated 2.0 schema
- Using shields.io for the license badge
- Pass whether useStubs is enabled for swagger-router downstream
Fixes #24
- Reverted change to default controller handling for swagger-router
- Removed unused module imports to fix build
- Added support to swagger-router for searching an array of directories for controllers
Fixes #19
- Updated 2.0 schema with upstream changes
- Brought back semantic validation
1.2 is back where it was prior to being removed 2.0 is a work in progress but is as complete as possible due to lack of documentation
- 0.5.1
None
- Finished first pass at Swagger 2.0 support for swagger-validator middleware
- Change the license from Apache 2.0 to MIT.
Fixes issue #16
- Update swagger-validator to handle charset and other Content-Type parameters.
Fixes issue #17
- 0.5.0
None
- Added support for 2.0 to the validation API and removed unfinished code
Removed the CLI shell Removed the semantic validation from 1.2 for now so we could write a better version that would allow for 1.2 and 2.0 validation
- Updated README for 1.2 and 2.0 validation examples
Minor refactoring of swagger-metadata middleware for consistency
- Incremental commit with first pass at 2.0 support for middleware
Missing swagger-validator middleware for 2.0 due to it not being complete
- 0.4.8
None
- Update README.md
- Do not do extra validation in swagger-validator if the value is not present.
Suggested by grahamj
- Updated swagger-router to use '_' instead of '#' for nickname mapping
'#' is an invalid character so the file would fail Swagger document validation. Found by grahamj
- 0.4.7
None
- Update Travis to only build 'master' for now
- Removed a few unused variables
- When available, use the resource basePath when creating route handles for swagger-metadata
Fixed #14
- 0.4.6
None
- More badges
- Fixed a few failing badges
- Removed GitHub releases badge due to upstream issues
- Minor README refactoring
- Moved away from shields.io for the quick/changing badges due to conflicts
- Validation errors now return an array of JSON paths instead of a string
Fixes #4
- 0.4.5
None
- Make stub handler respond with information about the controller being stubbed
Fixes #11
- Added badges and Travis support
Updated all dependencies/devDependencies Fixed tests related to failing tests
- 0.4.4
None
- Correctly require() controller path
path.join() strips leading ./ which is necessary for referencing files by relative path.
Join dir and controllerName manually.
- Use relative controller path in router example
Use a relative path in the router example rather than complete OSX path, which my previous commit enables.
waves to OSX user jwhitlock ;)
- Merge pull request #12 from DotLinker/master
Correctly require() controller path
- Use path.require(path.join(...)) for locating controllers
- 0.4.3
None
- Update location of schema files to work.
Fixes #10
- 0.4.2
None
- Update documentation to show the new middleware
- 0.4.1
None
- Minor refactoring for easier debugging
All functions are now named
- Moved reusable logic from swagger-validator middleware to swagger-metadata
This middleware will annotate the request object (req.swagger) with pertinent Swagger information based on the request This middleware will not annotate the request if the request does not match a Swagger defined operation Fixes issue #9
- Update swagger-validator middleware to use/require swagger-metadata
- Added 'swagger-router' middleware
- 0.4.0
None
- Made API validation not do semantic versioning if structural validation fails
- 0.3.2
None
- Fix README to highlight new code sample
- Removed all unnecessary checks in swagger-validator middleware working around invalid Swagger documents
- 0.3.1
None
- Added Connect middleware for pre-route validation based on Swagger resource documents
- 0.3.0
None
- Added missing test
- Updated README for new API and usage
- Updated README for updated features
- Changed severity of unused authorizations/authorization scopes
- 0.2.1
None
- Fixed a typo in the README
- Added validations related to defaultValues
- Finished up first pass of v1.2 semantic validation
Validates declared but unused resources in the resource listing Validates declared but unused authorizations in the resource listing Validates declared but unused authorization scopes in the resource listing Validates duplicate resource paths in the resource listing Validates missing authorizations in apiDeclaration Validates missing authorization scopes in apiDeclaration Validates duplicate resource paths in apiDeclaration Validates multiple swagger versions used in apiDeclaration Validates missing apiDeclaration (no resource listing for it)
- 0.2.0
None
- Various operation validations
Add error for duplicate method in operations Add error for duplicate nickname in operations Add error for duplicate code in responseMessages Add warning for summary greater than 120 characters in length
- 0.1.6
None
- Minor refactoring.
- Finished first pass at model validation
Add error for model with discriminator but no subTypes Add error for model with undefined required property
- 0.1.5
None
- Added check for duplicate model ids
- Added support for identifying cyclic models
- Various model validation enhancements
Fix cyclical model identification Add warning for duplicate entries in model subTypes Add error for model multiple inheritance Add error for model subType redeclaring property of ancestor
- 0.1.4
None
- Fixed a bug due to dataType.json not having complete list of primitives
- 0.1.3
None
- v1.2 validation handles missing model references and unused models
Errors for references to missing models Warnings for models with no references
- 0.1.2
None
None
None
DONE
Having Trouble? Try posting your question to the Apigee Community. Or, for more links and resources, check out our Help Page
| Need help? Visit the Apigee Community ! |
|---|
-
Getting started
-
Add policies to your API
-
Add security policies
-
Deploy your projects
-
Programmatic hooks
-
Good to know about
-
Deep dives
-
Reference topics
-
Troubleshooting and getting help
-
Related resources