Project

General

Profile

Feature #6562

Support API v2, remove experimental label

Added by Dominic Cleal over 4 years ago. Updated 8 months ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
API
Target version:
Difficulty:
Triaged:
Bugzilla link:
Team Backlog:
Fixed in Releases:
Found in Releases:

Description

I'd propose that:

  • Foreman 1.6 has API v2 as a stable, supported API on par with API v1
  • Foreman 1.6 continues to have API v1 as the default (i.e. when no accept header or versioned URL is used)
  • 1.6 release notes strongly recommend users switch to versioned access (at least) and to begin migration to API v2
  • Foreman 1.7 makes API v2 the default, v1 becomes deprecated (possibly via a plugin which may not be installed by default, if we feel that's easier to maintain)
  • Foreman 1.8 either won't ship v1 or it may be available as a plugin

So this ticket should remove the experimental label from v2 and call it stable in the API docs.

Associated revisions

Revision 7eb6ff00 (diff)
Added by Dominic Cleal over 4 years ago

fixes #6562 - APIv2 is declared stable as of the next release

History

#1 Updated by Dominic Cleal over 4 years ago

https://groups.google.com/forum/#!msg/foreman-dev/uEMN-Bl3o0U/_9T3qpBFN2MJ had a discussion about changing the default in 1.5, which wasn't resolved/done. I've mentioned this ticket on -dev here for disucssion: https://groups.google.com/forum/#!topic/foreman-dev/C0zYCMKoh8s

#2 Updated by Dominic Cleal over 4 years ago

  • Status changed from New to Ready For Testing
  • Assignee set to Dominic Cleal
  • Target version set to 1.8.0
  • Pull request https://github.com/theforeman/foreman/pull/1579 added
  • Pull request deleted ()

#3 Updated by Dominic Cleal over 4 years ago

  • Status changed from Ready For Testing to Closed
  • % Done changed from 0 to 100

Also available in: Atom PDF