Uploaded image for project: 'ERM Platform'
  1. ERM Platform
  2. ERM-1985

Publish mod-agreements API documentation on dev.folio.org

    XMLWordPrintable

Details

    • Bienenvolk

    Description

      FOLIO publishes API documentation at https://dev.folio.org/reference/api/

      However, mod-agreements' API documentation is at https://github.com/ostephens/folio-erm-agreements-api-os/ , it is not easy to find, and developers cannot update both the implementation and documentation in a single pull request when working on a feature.

      Solution:

      1. Move mod-agreements' API documentation into https://github.com/folio-org/mod-agreements
      2. Deploy to https://dev.folio.org/reference/api/ by configuring the Jenkins job: https://dev.folio.org/guides/api-lint/#jenkinsfile-for-oas

       

      TestRail: Results

        Attachments

          Issue Links

            Activity

              People

                Unassigned Unassigned
                julianladisch Julian Ladisch
                Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                  Created:
                  Updated:

                  TestRail: Runs

                    TestRail: Cases