Uploaded image for project: 'OpenAM'
  1. OpenAM
  2. OPENAM-14978

Improve API Version documentation and Guidance

    Details

      Description

       

      Issues such as https://bugster.forgerock.org/jira/browse/OPENAM-14942 highlight the need for further documentation and guidelines  on our API versioning possibly including:

      backward compatibility

      forward compatibility

      structured representations

      what is considered breaking/non breaking

      client development best practice

       

      Current documentation

      https://backstage.forgerock.com/docs/am/6.5/authorization-guide/#sec-rest-api-versioning 

        Attachments

          Issue Links

          is related to

          Bug - A problem which impairs or prevents the functions of the product. OPENAM-14942 AM ../sessions API Does Not Honour API Versioning

          • Blocker - Blocks development and/or testing work, production could not run.
          • Resolved

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                jonthomas Jonathan Thomas
              • Votes:
                1 Vote for this issue
                Watchers:
                7 Start watching this issue

                Dates

                • Created:
                  Updated: