Details

    • Type: Task
    • Status: Closed
    • Priority: Should
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.21.0
    • Complexity:
      Low

      Description

      Right now, the Swagger UI and static docs generated by the code in both branches of this repo basically just document the resources.

      Some additional text should be written that we can include at the top of the docs that discusses the following topics:

      • Authentication - we should explain that we use basic auth and recommend best practices
      • Basic query search - we should say that some resources support the "q" parameter (at least until RESTWS-561 is resolved)
      • Representations - we should explain the concept of default, full and custom representations

      The wiki page at https://wiki.openmrs.org/x/P4IaAQ has some of the content that should go in the overview docs.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                gayanw Gayan Weerakutti [X] (Inactive)
                Reporter:
                pascal Pascal Brandt
                Designated Committer:
                Daniel Kayiwa
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: