Uploaded image for project: 'Webservices REST Module'
  1. Webservices REST Module
  2. RESTWS-661

Mark required search params 'required' in swagger

    XMLWordPrintable

Details

    • Bug
    • Status: Closed
    • TBD
    • Resolution: Won't Fix
    • None
    • None
    • None
    • Undetermined

    Description

      In the Swagger documentation, required search params should be marked required for resources on which at least one search parameter must be specified.

      In other words if a resource has no fetch all but has search handler, required params of that SearchHandler should be marked required for that resource in the Swagger definition.

      https://github.com/openmrs/openmrs-module-webservices.rest/blob/820bf3d0bdc92f40230a573659af714d99d832f0/omod-common/src/main/java/org/openmrs/module/webservices/docs/swagger/SwaggerSpecificationCreator.java#L769

      https://github.com/openmrs/openmrs-module-webservices.rest/blob/820bf3d0bdc92f40230a573659af714d99d832f0/omod-2.0/src/main/java/org/openmrs/module/webservices/rest/web/v1_0/search/openmrs2_0/EncounterSearchHandler2_0.java#L48

      Gliffy Diagrams

        Attachments

          Activity

            People

              Unassigned Unassigned
              gayanw Gayan W.
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: