Skip to content

Improve and update API versioning#2

Merged
skupriienko merged 12 commits into
mainfrom
api-versioning
Feb 11, 2025
Merged

Improve and update API versioning#2
skupriienko merged 12 commits into
mainfrom
api-versioning

Conversation

@skupriienko
Copy link
Copy Markdown
Collaborator

@skupriienko skupriienko commented Feb 6, 2025

Links:

Actions:

  • client.py:

    • Rewrite Config's __getitem__() to handle API versions implicitly.
    • add "sending_queues"
    • create special_cases with different API versions
    • handle v3_domain_endpoints
  • Add missing examples:

    • DOMAINS:
      • update_simple_domain()
      • delete_all_domain_credentials()
      • get_sending_queues()
    • MAILING_LISTS:
      • get_lists()
      • get_member_list()
    • _SUPPRESSIONS_:
      • get_single_complaint()
      • delete_all_whitelists()
    • WEBHOOKS:
      • get_webhook()
  • Remove a deprecated example:

    • mailgun/examples/stats_examples.py (it will be replaced with metrics)
  • Docstrings:

    • fix docstrings of view_message_with_storage_url()
  • Demo csv files:

    • fix mailgun/doc_tests/files/mailgun_bounces_test.csv
    • fix mailgun/doc_tests/files/mailgun_unsubscribes.csv
    • add mailgun/doc_tests/files/data.csv
  • Fix/improve handlers by correctly managing endpoints:

  • Tests:

    • Remove:
      • deprecated StatsTests as they will be replaced with metrics.
    • Add:
    • test_update_simple_domain
    • test_get_sending_queues
    • test_maillists_lists_members_get
    • test_delete_all_domain_credentials but skip it because if all credentials are deleted then test_update_simple_domain fails
    • All tests pass
  • CI:

    • Update pre-commit hooks
  • Style

    • Formatting & linting with pre-commit
    • Add more ignoring rules to ruff settings
  • docs:

    • Update README.md
    • License name is Apache-2.0
  • Package Management:

    • update project's name in pyproject.toml
    • update project.urls in pyproject.toml
    • license is Apache-2.0
    • update conda.recipe

- Add missing examples.

- Fix demo bounces & unsubscribes csv files, add data.csv file

- Fix domain_handlers and ip_pools_handles by correctly managing entry points.

- Remove deprecated StatsTests.

- Update README.md
@skupriienko skupriienko self-assigned this Feb 6, 2025
@skupriienko skupriienko marked this pull request as ready for review February 6, 2025 22:46
@skupriienko skupriienko merged commit 9f1fd1e into main Feb 11, 2025
@skupriienko skupriienko deleted the api-versioning branch February 11, 2025 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant