v0.3.5-beta

0.3.5-beta (Oct 13, 2024)

Below is a list of all new features, APIs, deprecations, and breaking changes.

Bug Fixes

• Handle some cases where schemas do not exist in openapi.json file. Fix a single defect in an endpoint making the whole process stop. Empty schemas fallbacks to an empty object ({})
• This was fixed in openapi-diff-node v2.1.1

v0.3.4-beta

0.3.4-beta (July 29, 2024)

Below is a list of all new features, APIs, deprecations, and breaking changes.

Bug Fixes

• Commit all missing distribution files (/dist) since v0.3.2-beta.
• Add a warning to commit /dist files to the pull request template.

v0.3.3-beta

0.3.3-beta (July 24, 2024)

Below is a list of all new features, APIs, deprecations, and breaking changes.

PR: #22

Improvements

• update openapi-diff-node to v2.1.0 (use summary as a fallback when description is empty)

Other Changes

• openapi-diff-node upgraded from v2.0.0 to v2.1.0

v0.3.2-beta

0.3.2-beta (July 24, 2024)

Below is a list of all new features, APIs, deprecations, and breaking changes.

PR: #21

New Features

• Descriptions of API endpoints are now shown in main message. (Thanks to openapi-diff-node v2.0.0)

Improvements

• Arrays in schemas (in both parameters AND request/response bodies) are now displayed with improved readability. This works particularly well with ENUMs, in which possible values of are provided as an array.

Other Changes

• openapi-diff-node upgraded from v1.1.0 to v2.0.0

v0.3.1-beta

0.3.1-beta (July 14, 2024)

Below is a list of all new features, APIs, deprecations, and breaking changes.

New Features

• None.

Improvements

• None.

Other Changes

• None.

Bug Fixes

• Remove Unnecessary console.log()s.
• Re-build distribution files with missing code.

v0.3.0-beta

0.3.0-beta (July 14, 2024)

Below is a list of all new features, APIs, deprecations, and breaking changes.
PR: #17

New Features

• Enums and examples are now shown in slack messages.
• Properties which are not available or not provided are not shown in slack messages to save space.
• ChangeLogs will show a detailed diff of properties in fields.

Improvements

• None

Other Changes

• openapi-diff-node ^1.0.1 -> 1.1.0

Bug Fixes

• Distinguish required field being not available (N/A) and being false.

v0.2.2-beta

0.2.2-beta (July 14, 2024)

Below is a list of all new features, APIs, deprecations, and breaking changes.
PR: #15

New Features

• None.

Improvements

• None.

Other Changes

• None.

Bug Fixes

• Gracefully handle empty description coming in as an empty string. (Slack API forbids empty text fields)
• Restore default file path for local environment. (openapi-base-aws.json -> openapi-base.json, same for the head file)
• Add fetch-depth: 2 to ci.yml as at least two latest commits are needed to work on push event.

v0.2.1-beta

0.2.1-beta (July 14, 2024)

Below is a list of all new features, APIs, deprecations, and breaking changes.
PR: #14

New Features

• None

Improvements

• Define valid inputs in action.yml
• Add default pull request template.

Other Changes

• SHA is no longer being retrieved from process.env.GITHUB_SHA. This will be provided by the user manually in github actions configuration file.

Bug Fixes

• Fix fetching openapi.json not working on 'push' event. (works fine on 'pull_request' event. )
• Fix setting default value for openapi path error cause by core.getInput() always returning an empty string even when the value is not provided.

v0.2.0-beta

0.2.0-beta (July 14, 2024)

Below is a list of all new features, APIs, deprecations, and breaking changes.

New Features

• Diffs are not only provided as a github actions output, but also can be sent to slack channels. Slack class was added to handle all slack-related tasks. Credentials for Slack and channel Ids must be provided. Details can be seen in README.md
• Internationalization (i18n) support for Korean for Slack messages. Locale can be provided as a Github Actions input.
• Supports both pull_request event and push event. pull_request will compare the base branch and push will compare the target branch, and the state of one commit behind the target branch.
• Path for openapi json file can be provided as a Github Actions input. Default is openapi.json at the root directory of the project.
• Output of the diff can now be accessed via diff_result. result will be deprecated in future releases.

Improvements

• Diffing task of two openapi documents is now done by an external library, openapi-diff-node a javascript-based diffing library for nodeJS. All existing diffing codes are removed.

Other Changes

• Set default font to Pretendard for development (debugging) web page. Fallback fonts will be used if Pretendard is not installed locally. (Font file not included)
• Irrelevant test cases are removed. Test cases will be added in future releases.

v0.1.0-alpha

What's Changed

• Release/v0.1.0 alpha by @jaychang99 in #6

Changes

• fix README to have the correct development environment setup script

Major Changes

• If no added / modified / removed endpoints are detected,h1-level title will no longer appear.
• Format JSON-type data into flattened table, not in a JSON code snippet for improved readability
• parse JSON-type data recursively (as opposed to exisiting 2-depth parsing)
• add checkmark ✅ on added JSON properties

Full Changelog: v0.0.2-alpha...v0.1.0-alpha