Skip to content

Explore Hypothesis API v2.0 support #8

Description

@rdhyee

Overview

Investigate the Hypothesis API v2.0 (currently experimental) and plan for future support in this library.

Background

This library currently implements API v1.0 (stable). Hypothesis has an experimental v2.0 API with changes worth understanding for future-proofing.

Research Tasks

  • Review v2.0 API documentation at https://h.readthedocs.io/en/latest/api-reference/v2/
  • Compare v1.0 vs v2.0 endpoints and response formats
  • Identify breaking changes that would affect this library
  • Identify new capabilities in v2.0
  • Check v2.0 stability status (still experimental?)

Key Questions to Answer

  1. Authentication: Does v2.0 change auth mechanisms?
  2. Pagination: Does v2.0 fix the cursor pagination issues we worked around?
  3. Response format: Are annotation objects structured differently?
  4. New endpoints: What new functionality does v2.0 expose?
  5. Deprecations: What v1.0 endpoints are deprecated or removed?
  6. Timeline: Any indication when v2.0 becomes stable?

Implementation Considerations

  • Can we support both v1.0 and v2.0 simultaneously?
  • Should v2.0 be a separate class (APIv2) or a version parameter?
  • What's the migration path for existing users?

Deliverables

  1. Research document: Summary of v2.0 changes and implications
  2. Recommendation: Whether/when to add v2.0 support
  3. Implementation plan: If proceeding, how to structure the code

References

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions