Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Critical Critical
    • Resolution: Won't Fix
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: API (A)
    • Labels:

      Description

      The present lack of a change log for API changes is sub-optimal.

      Due to the nature of the API changes I suggest using a wiki page documenting these changes on a per version basis. When a new version comes out a new wiki page should be created and the former pages be set to read only. If possible it would be useful to also note the revision number or branch/tag where the change was made.

        Activity

        Hide
        richlv added a comment -

        all api changes from 1.8 to 2.0 should be documented at http://www.zabbix.com/documentation/2.0/manual/appendix/api/changes_1.8_-_2.0

        if you see any missing, please scream and shout

        Show
        richlv added a comment - all api changes from 1.8 to 2.0 should be documented at http://www.zabbix.com/documentation/2.0/manual/appendix/api/changes_1.8_-_2.0 if you see any missing, please scream and shout
        Hide
        nelsonab added a comment -

        This is a good start, however I think it needs better detail going forward in 2.0. For instance fixing a bug in 2.1 for example may break a work around a 3rd party developer put in place for a bug in 2.0. Without a note saying bug ZBX-xxxx was resolved may lead to some expletives when users start complaining that the 3rd party library is broken.

        Show
        nelsonab added a comment - This is a good start, however I think it needs better detail going forward in 2.0. For instance fixing a bug in 2.1 for example may break a work around a 3rd party developer put in place for a bug in 2.0. Without a note saying bug ZBX-xxxx was resolved may lead to some expletives when users start complaining that the 3rd party library is broken.
        Hide
        richlv added a comment -

        to clarify the last comment, does it mean that you would like to see a separate changelog for all api related fixes in each version, or is it about something else ?

        Show
        richlv added a comment - to clarify the last comment, does it mean that you would like to see a separate changelog for all api related fixes in each version, or is it about something else ?
        Hide
        nelsonab added a comment -

        I guess what I'm interested in seeing is which revisions/tickets are associated with the various changes. I know this may not always be possible but when that information is available it may help track down new or regression issues. Also some example before/after code snippets may help as well. I think we'll really start to know more when we get to 2.1 and we have a changes sheet for 2.0 to 2.1 to really get a good understanding of how this should work better.

        As I said before I think we're off to a good start on this.

        Show
        nelsonab added a comment - I guess what I'm interested in seeing is which revisions/tickets are associated with the various changes. I know this may not always be possible but when that information is available it may help track down new or regression issues. Also some example before/after code snippets may help as well. I think we'll really start to know more when we get to 2.1 and we have a changes sheet for 2.0 to 2.1 to really get a good understanding of how this should work better. As I said before I think we're off to a good start on this.
        Hide
        Alexei Vladishev added a comment -

        I am closing it. Great suggestion, but it shouldn't be reported as a bug.

        Show
        Alexei Vladishev added a comment - I am closing it. Great suggestion, but it shouldn't be reported as a bug.

          People

          • Assignee:
            Unassigned
            Reporter:
            nelsonab
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: