Api Elements.js Versions Save

Library for consuming API Elements in JavaScript

@apielements/[email protected]

3 years ago

Bug Fixes

  • Prevents the parser from throwing an unhandled error while parsing components which use keys which are the same as an API Element type identifier. The parser will now produce a handled error mentioning that these keys are reserved and currently unsupported in the parser.

[email protected]

3 years ago

Bug Fixes

  • Fixes the hosts property in api category to return the hosts category.

@apielements/[email protected]

3 years ago

Enhancements

  • Adds support for the Schema Object title property.

Bug Fixes

  • Adds an accept header to requests with the matching responses content type.

@apielements/[email protected]

3 years ago

Enhancements

  • Adds partial support for using oneOf in a Schema Object. One of is supported when used in a schema object alone, or with the nullable constraint or any annotation. It is not supported in the case when one of is used in conjunction with other constraints in the same schema object.

Bug Fixes

  • Supports using $ref in the root of a component, for example:

    components:
      schemas:
        UserAlias:
          $ref: '#/components/schemas/User'
        User:
          type: object
    
  • Prevents the parser from throwing an error upon encountering an unknown or invalid YAML node tag, such as !!unknown.

@apielements/[email protected]

3 years ago

This update incorporates changes from API Element Adapters:

  • openapi3-parser 0.14.0

@apielements/[email protected]

3 years ago

Enhancements

  • Performance improvements to OpenAPI 2 validation, this will only apply to validation only. Full OpenAPI 2 parsing is not altered.

Bug Fixes

  • Returns a validation error while trying to parse a YAML or JSON object which does not contain the swagger key, in prior versions the parser may have crashed under some inputs.
  • Improved clarity of validation error messages.
  • Fixes a case where the source map information may be missing for one type of validation errors.

@apielements/[email protected]

3 years ago

Bug Fixes

  • The generateMessageBody and generateMessageBodySchema adapter options are now respected.

@apielements/[email protected]

3 years ago

Bug Fixes

  • Prior versions of the adapter reported the following 'Header Object' keys as invalid: style, explode, allowReserved, schema, content, example, and examples. These will now return an unsupported warning instead.

  • Negative boolean YAML values was previously treated as true and thus Parameter Object's with required: false would have been incorrectly treated as required.

@apielements/[email protected]

3 years ago

The package has been renamed to @apielements/remote.

@apielements/[email protected]

3 years ago

Bug Fixes

  • This release includes performance improvements to parsing documents which contain the same schema re-used via a reference ($ref) many times in request parameters and response bodies under an allOf key.