v0.0.2-alpha

What's Changed

• Release/v0.0.2 alpha by @jaychang99 in #4

---

• No significant features changes. Refactoring and code improvements only.

• Refactor markdown-related code.
  • create table() markdown util for tables.
• code in generateMarkdownDiff() refactored to have as little responsibility as possible.
• add baseUrl as src in tsconfig.json
• fix typos
• remove unnecessary comments and console logs.
• update README.md

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

Initial Pre-release

⚠️ For now this may only work in public repositories due to permission issues.

For, now openapi.json is openapi-V3-compliant. Other versions may have issues.

• On every push after a PR has been submitted, this action will be triggered.
  • This will detect openapi.json in the root directory and diff changes openapi.json with the base branch's openapi.json (which also must be in the root directory
  • Changes are categorized into 3 types.
    • Added API Endpoints
      • These are REST API endpoints that are not present in the base branch's openapi.json but are present on HEAD ref's openapi.json.
    • Modified API Endpoints
      • These are REST API endpoints that are present in both the base branch's openapi.json and HEAD ref's openapi.json, but with changes. Any change are accepted as 'modification' as this internally compares two different stringified JSON objects.
    • Removed API Endpoints
      • These are REST API endpoints that are present in the base branch's openapi.json, but not in HEAD ref's openapi.json.

What's Changed

• Features for diffing openapi-compatible json specs. by @jaychang99 in #2

New Contributors

• @jaychang99 made their first contribution in #2

Full Changelog: https://github.com/jaychang99/github-actions-openapi-diff/commits/v0.0.1-alpha