aws / aws/industry-toolkit

[FEATURE] Detect if API change is breaking

Open
#21 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
13
Forks
1
PR merge metrics
No merged PRs in 30d

Description

# Add Automatic Detection of Breaking API Changes Using Amazon Bedrock

**Description:**
The Industry Toolkit will integrate Amazon Bedrock to automatically detect if a breaking change has been introduced to an API. This feature will analyze API modifications and flag potential breaking changes, such as changes to request/response formats, removal of endpoints, or alterations in expected behavior, helping developers maintain API backward compatibility.

### Feature Requirements:
- Integrate Amazon Bedrock to analyze API changes and detect potential breaking changes.
- Support detection of breaking changes in areas like request/response models, endpoint removals, and method behavior.
- Provide detailed feedback on what the breaking changes are and how they impact existing consumers of the API.
- Automatically flag breaking changes during the API update process, allowing developers to take corrective actions.
- Write tests to validate the detection of breaking changes and ensure proper integration with the toolkit.
- Include documentation on how to use this feature and how breaking changes are identified.

### Acceptance Criteria:
- [ ] Integration with Amazon Bedrock for detecting breaking API changes is implemented.
- [ ] Breaking changes in request/response models, endpoints, and behaviors are detected and flagged.
- [ ] Detailed feedback on breaking changes is provided to developers.
- [ ] Tests are written and passing to validate the detection mechanism.
- [ ] README and documentation are updated with instructions on using this feature.

**Additional Context:**
This feature will help developers ensure that their APIs remain backward compatible, reducing the risk of introducing breaking changes and enhancing overall API stability.

Contributor guide

Open the contributing guide

Research direction

Start with the README and map the toolkit's API update process before defining how Amazon Bedrock would receive and analyze API changes. The work is done when breaking request/response, endpoint, and behavior changes are flagged with detailed feedback, tests pass, and the README and documentation explain setup and usage.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, python
Domain
ai, api, cloud
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.