NCIOCPL / sitewide-search-api

0 stars 4 forks source link

Documentation bug for collection parameter #41

Closed bkline closed 1 year ago

bkline commented 3 years ago

Issue description

The documentation which appears in the swagger interface says

Collection is of the form {sitename}_{lang_code}. Currently, {sitename} is always "cgov" and {lang_code} may /// be either "en" (English) or "es" (Español).

In fact, the language code is a separate parameter. Appending it to the sitename in the collection parameter (separated by an underscore as specified in the documentation) results in a 500 ("Internal server error") response.

ESTIMATE sp:1

Steps to reproduce the issue

  1. Bring up the SWS swagger interface (https://webapis.cancer.gov/sitewidesearch/v1)
  2. Click on Autosuggest
  3. Click on GET /Autosuggest/{collection}/{language}/{term}
  4. Click the Try it out button
  5. Enter cgov_en in the field for the collection parameter
  6. Enter en in the field for the language parameter
  7. Enter hea in the term field
  8. Click the Execute button

What's the expected result?

What's the actual result?

Additional details / screenshot

blairlearn commented 1 year ago

Documentation has been updated.