Skip to content

Design a versioning scheme for the harvest admin API #5128

Closed
Closed
Design a versioning scheme for the harvest admin API#5128
Assignees
Aguiardavidm
Labels
APIHarvester

Description

@neilmb
neilmb
opened on Mar 11, 2025

We anticipate the harvest admin API being publicly available. Best practice for public APIs is to use a versioning system so that the API can be iterated on without breaking things for API users who depend on the previous behavior. See e.g. https://restfulapi.net/versioning/ for more details.

For this ticket, we should choose how we want to version our API (in the URI or in request headers) and make a plan and a follow-up ticket for implementing that pattern. Implementing the versioning is not required here.

Activity

  1. neilmb
    added this to data.gov team boardon Mar 11, 2025
  2. btylerburton
    transferred this issue fromGSA/datagov-harvesteron Mar 13, 2025
  3. btylerburton
    added
    Harvest-DBPostgres and related DB tickets
    on Mar 13, 2025
  4. Bagesary
    moved this to 📟 Sprint Backlog [7] in data.gov team boardon Mar 13, 2025
  5. Bagesary
    moved this from 📟 Sprint Backlog [7] to No status in data.gov team boardon Mar 13, 2025
  6. btylerburton
    moved this to 📥 Queue in data.gov team boardon Mar 13, 2025
  7. neilmb
    added
    not-mvp
    on Apr 15, 2025
  8. tdlowden
    moved this from 📥 Queue to New 📤 Queue in data.gov team boardon Sep 16, 2025
  9. tdlowden
    moved this from New 📤 Queue to 📥 Queue in data.gov team boardon Sep 16, 2025
  10. SueValente
    moved this from 📥 Queue to No status in data.gov team boardon Feb 25, 2026
  11. SueValente
    added
    API
    and removed
    not-mvp
    on Mar 10, 2026
  12. SueValente
    added
    Harvester
    on Apr 6, 2026
  13. SueValente
    added this to the Harvest.d.g Error Management Improvements milestone on Apr 7, 2026
  14. SueValente
    moved this to 📥 Queue in data.gov team boardon Apr 9, 2026

  15. 4 remaining items

  16. SueValente
    removed this from the Harvest.d.g Error Management Improvements milestone on Apr 30, 2026
  17. SueValente
    added a parent issue on May 14, 2026
  18. SueValente
    moved this to O&M Backlog in data.gov team boardon May 20, 2026
  19. SueValente
    moved this from O&M Backlog to 📥 Queue in data.gov team boardon Jun 24, 2026
  20. SueValente
    removed a parent issue on Jun 24, 2026
  21. SueValente
    added a parent issue on Jun 24, 2026
  22. SueValente
    removed a parent issue on Jul 23, 2026
  23. SueValente
    added a parent issue on Jul 23, 2026
  24. SueValente
    moved this from 📥 Queue (up next) to 📟 Sprint Backlog (Top Priority) in data.gov team boardon Jul 29, 2026
  25. Aguiardavidm
    self-assigned this
    on Aug 6, 2026
  26. Aguiardavidm
    moved this from 📟 Sprint Backlog (Top Priority) to 🏗 In Progress in data.gov team boardon Aug 7, 2026
  27. Aguiardavidm
    moved this from 🏗 In Progress to ✔ Done in data.gov team boardon Aug 11, 2026
  28. Aguiardavidm
    closed this as completedby moving to ✔ Done in data.gov team boardon Aug 11, 2026
  29. SueValente
    removed a parent issue on Aug 11, 2026
  30. SueValente
    moved this from ✔ Done to 🗄 Closed in data.gov team boardon Aug 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

APIHarvester

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions