search

zimmerman-team / IATI.cloud

IATI datastore powered by Apache Solr. Automatically Extracts and parses IATI XML files referenced in the IATI Registry & refreshed every 3 hrs. IATI is a global initiative to improve the transparency of development and humanitarian resources and their results for addressing poverty and crises.
https://datastore.iati.cloud
MIT License
32 stars 28 forks source link

API documentation error: GET humanitarian_scope_type (optional) #2527

Closed amy-silcock closed 3 years ago

amy-silcock commented 3 years ago

Describe the bug The api documentation has a request parameter GET humanitarian_scope_type (optional)

The example provided uses the humanitarian field which I think belongs to the humanitarian flag? As opposed to the humanitarian_scope_type ?

To Reproduce Steps to reproduce the behavior:

  1. Go to https://iatidatastore.iatistandard.org/documentation/4b7dd46f-b6c0-43f5-afe7-912faf8e236f#humanitarian_scope_type%20(optional)
  2. Run the query
  3. Choose an activity and verify results (look at xml or use d-portal)
  4. An example is this activity: http://d-portal.org/q.xml?aid=US-EIN-13-3327220-SHINE. which contains a hum flag boolean but not the hum scope element.

Expected behavior I expect the documentation name to match the query. Both humanitarian and humanitarian_scope_type should be included in the documentation

Screenshots If applicable, add screenshots to help explain your problem. image

image

amy-silcock commented 3 years ago

Duplicated