Project

General

Profile

Feature #1675

API: 0.3 stable, 0.2 deprecated

Added by Bernhard Koschiček-Krombholz 8 months ago. Updated 6 months ago.

Status:
Closed
Priority:
Normal
Category:
API
Target version:
Start date:
2022-03-31
Estimated time:

Description

All endpoints of the versionless /api/ path are pointed to version 0.3 instead of 0.2.

Version 0.2 will be deprecated.
Version 0.3 will be the new stable version.


Related issues

Related to OpenAtlas - Feature #1574: Dates with hours, minutes and secondsClosed2021-09-11Actions

History

#1

Updated by Bernhard Koschiček-Krombholz 8 months ago

  • Status changed from New to Assigned
#2

Updated by Alexander Watzinger 6 months ago

A few suggestions:

  • Before merging into develop please tell me, it's easier to compare as long as the changes are in a different branch. Maybe we can take a look together before
  • This release should be in combination with #1574 (Dates with hours and minutes) because it's a good opportunity to change the output of dates
  • Why not raise the version to 1.0.0? For me 0.x.x releases have a strong "unfinished" vibe but the API has already a lot of tested functionality used in productive environments. Also as far as I know the new versions contains breaking changes and the number schema (similar to OpenAtlas versioning) would be major.minor.fix, see Features versioning and roadmap, so it would make sense to change the first number.
#3

Updated by Alexander Watzinger 6 months ago

  • Related to Feature #1574: Dates with hours, minutes and seconds added
#4

Updated by Bernhard Koschiček-Krombholz 6 months ago

Thank you for your comment. It is a good idea to change the versioning. But for this version I think I will stick with 0.3. The reason is that the naming of the endpoints need to be changed to better describing the endpoints without documentation. Currently, I have no time for this and this is again a major breaking change. So we would change very fast from v1 to v2. I think this will be done over the summer, in autumn we will delete version 0.2 and make a unstable v1 with new documentation and new naming of endpoints.

#5

Updated by Alexander Watzinger 6 months ago

Sounds reasonable and I'm looking forward to a 1.0.0 release in autumn, which we should definitely celebrate than :)

#6

Updated by Bernhard Koschiček-Krombholz 6 months ago

  • Status changed from Assigned to Closed

In develop branch

Also available in: Atom PDF