All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
- [FIXED] - renamed project to
serviser-sdk
- [FIXED] - template variables in section of method jsdoc comments referenced incorrect path to schema type (the path has changed with OpenAPI v3)
- [ADDED] - support for building for web (webpack@4 & browserify)
- [ADDED] - support for
[email protected]
which usesOpenAPI v3
- [FIXED] -
npm install
should be executed with--no-save
option when installing dependencies for tests
- [FIXED] - reserved javascript keywords should not be used as variable names
- [FIXED] - do not demand url path parameter values to be of string type
- [FIXED] - a SDK constructor name should incorporate an application name the sdk is built for (fixes #3)
- [FIXED] - AMQP SDKs were being assigned incorrect endpoint method types
- [FIXED] - make
jshint
a regular dependency instead ofdevDependency
- [FIXED] - print warning when an error occurs during sdk plugin registration
- [ADDED] -
--specs
option toserviser-sdk
executable - [ADDED] - make use of serviser shell API -
build:sdk
command is available viaserviser
executable
- [FIXED] - broken prototype inheritance
- [FIXED] - broken inheritance of http
BIServiceSDK
interface - invalid prototype value
- [FIXED] - broken inheritance of http
BIServiceSDK
interface - invalid prototype value
- [FIXED] - we shouldn't try to build a sdk for unsupported API specification (determined via API protocol)
- [FIXED] - AMQP client sdk was failing to build due to multiple semantic errors
- [ADDED] - AMQP client SDK package generation
- [ADDED] - cli acceptance tests
- [ADDED] - print info about tmp build directory location
- [FIXED] - spawn node process with
--preserve-symlinks
flag - [FIXED] - when no default service host is set, an Error should be throwed when a SDK constructor is called without the
baseURL
option
- [FIXED] - custom Error constructors were being provided with incorrect response data
- [ADDED] -
version
shell option - [CHANGED] - npm package versioning schema of generated SDKs
- [FIXED] - request BODY payload was being excluded from
post
/put
/delete
requests - [FIXED] - added missing "test" npm command to builded SDK npm packages
- [ADDED] -
BIServiceSDK.prototype._setReqData
- adapter function mapping user API query|data|headers options to internal axios options: params|data|headers - [ADDED] - plugin function is called with context of
BIServiceSDK
- [FIXED] - failing tests for built SDKs
- [ADDED] - axios req response errors are converted to
SDKRequestError
. - [ADDED] -
BIServiceSDK.prototype.use
method - [ADDED] -
query
BIServiceSDK constructor option which is alias for theparams
constructor option - [CHANGED] - methods of generaged SDKs accept
query
option instead of theparams
option. - [CHANGED] - All methods accept
data
option which previously was supported only for POST|PUT|DELETE requests - [CHANGED] - error response object properties are converted to camelCase
- [FIXED] - when
axios.request(config)
method is called, the config object must contain object values forheaders
&data
¶ms
properties, they can NOT have other values likeundefined
&null
otherwise global config values will be incorrectly merged with request specific config
- [FIXED] bugfix in
0.5.5
was fixed incorrectly - [ADDED]
BIServiceSDK
tests
- [FIXED]
BIServiceSDK.prototype.$request
merge default options with request options object
- [FIXED] fetch
path
url parameters from url string if they are not provided by swagger schema - [FIXED] make it work on Windows - spawn
mocha.cmd
&npm.cmd
instead ofmocha
&npm
shel commands - [FIXED] prepend default
http(s)
protocol to thebaseURL
only if the url doesn't define protocol on its own
- [FIXED] Infinite loop when an Error occured while loading a serviser based app
- [FIXED] sdk constructor name string should be sanitized and non-alphanumberic characters should be replaced by
_
- [FIXED] add missing alias option
--help
=>-h
- [ADDED] SDK has
version
property which equals to API version string. - [FIXED] npm package.json template for SDK modules - updated required package version restriction
- [ADDED] initial implementation (run "serviser-sdk --help" in your shell for more info)