Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rename from ComplianceData to BatchComplianceData #462

Closed
myConsciousness opened this issue Oct 8, 2022 · 0 comments · Fixed by #476
Closed

Rename from ComplianceData to BatchComplianceData #462

myConsciousness opened this issue Oct 8, 2022 · 0 comments · Fixed by #476
Assignees
@myConsciousness
Labels
enhancement New feature or request service/Compliance

Comments

@myConsciousness
Copy link
Member

1. What could be improved

The official Twitter API specification addition reveals that ComplianceData is not a generic object, but can only be used with batch Compliance endpoints.

2. Why should this be improved

Clarify the name of the object as we add functionality to the Compliance endpoint.

3. Any risks?

It's necessary to rename from ComplianceData to BatchComplianceData. However, this should be followed by a migration period for this object name before making any disruptive changes.

Follow these steps:

  1. Add BatchComplianceData object.
  2. Do not delete the ComplianceData object now, extend BatchComplianceData and then deprecate it.
  3. Delete ComplianceData after a certain period of time.

4. More information
@myConsciousness myConsciousness self-assigned this Oct 8, 2022
@myConsciousness myConsciousness mentioned this issue Oct 10, 2022
Closed
myConsciousness added a commit that referenced this issue Oct 11, 2022
@myConsciousness
fix: fixed for the issue (#462)
5c08647
@myConsciousness myConsciousness linked a pull request Oct 11, 2022 that will close this issue
fix: fixed for the issue (#462) #476
Merged
7 tasks
bors bot added a commit that referenced this issue Oct 11, 2022
@bors @myConsciousness
Merge #476
9818091 
476: fix: fixed for the issue (#462) r=myConsciousness a=myConsciousness

# 1. Description

<!-- Provide a description of what this PR is doing.
If you're modifying existing behavior, describe the existing behavior, how this PR is changing it,
and what motivated the change. If this is a breaking change, specify explicitly which APIs have been
changed. -->

## 1.1. Checklist

<!-- Before you create this PR confirm that it meets all requirements listed below by checking the
relevant checkboxes (`[x]`). This will ensure a smooth and quick review process. -->

- [x] The title of my PR starts with a [Conventional Commit] prefix (`fix:`, `feat:`, `docs:` etc).
- [x] I have read the [Contributor Guide] and followed the process outlined for submitting PRs.
- [x] I have updated/added tests for ALL new/updated/fixed functionality.
- [x] I have updated/added relevant documentation in `docs` and added dartdoc comments with `///`.
- [x] I have updated/added relevant examples in `examples`.

## 1.2. Breaking Change

<!-- Does your PR require users to manually update their apps to accommodate your change?

If the PR is a breaking change this should be indicated with suffix "!"  (for example, `feat!:`, `fix!:`). See [Conventional Commit] for details.
-->

- [ ] Yes, this is a breaking change.
- [x] No, this is _not_ a breaking change.

## 1.3. Related Issues

<!-- Provide a list of issues related to this PR from the [issue database].
Indicate which of these issues are resolved or fixed by this PR, i.e. Fixes #xxxx* !-->

<!-- Links -->

[issue database]: https://github.com/twitter-dart/twitter-api-v2/issues
[contributor guide]: https://github.com/twitter-dart/twitter-api-v2/blob/main/CONTRIBUTING.md
[style guide]: https://github.com/twitter-dart/twitter-api-v2/blob/main/STYLEGUIDE.md
[conventional commit]: https://conventionalcommits.org


Co-authored-by: myConsciousness <kato.shinya.dev@gmail.com>
@bors bors bot closed this as completed in #476 Oct 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@myConsciousness myConsciousness

Labels
enhancement New feature or request service/Compliance
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: fixed for the issue (#462) twitter-dart/twitter-api-v2
1 participant
@myConsciousness