Misc feedback/suggestions for the Query API

  • Description of "Use alternate SQL method for code table finds" - that's probably a typo for "fields"

  • In the OpenAPI, the definition names you choose (i.e., a class names) matters and affects the quality/readability of generated code. You might consider changing the ExecuteQueryRequest definition name to ExecuteAdHocQueryRequest to better reflect its purpose of containing the params needed when starting an ad hoc query job. So instead of having the "...ById" language in the operation ID/summary/description/etc., consider adopting "Query" and "Ad Hoc Query" to distinguish pre-defined queries from ad hoc queries. For example, instead of StartQueryExecutionJobByID/ExecuteQueryByIdRequest you'd have StartAdHocQueryExecutionJob/ExecuteAdHocQueryRequest

  • "UseAmountInGrid" as a field name - you might consider choosing a more API-oriented term ("Grid" is more of a UX idiom)

  • The merge query details definitions use "query1" and "query2" for field names but "query A" and "query B" in the descriptions. You might consider changing the descriptions to match the field names ("query 1" and "query 2" language might be better choices anyway)

  • use_gross_amount_for_covenants has a description of "Gift processing gross amount option for UK Gift Aid (Net or Gross amount)". Is that accurate (iirc, Gift Aid and Covenant are different gift types in RE7)?

  • You're likely planning to do this already, but the Query API landing page could benefit from some bespoke docs like the initial content from the preview announcement blog post with guidance on how BB expects the API to be used (similar to the List v2 landing page content).

  • If I provide a select_from_query_id, does that query have to be of the same query type as the type_id specified? How does select_from_query_id work with select_fields?

  • The metadata returned for code table fields in the query tree doesn't indicate which code table the field uses...should it? I.e., is there extra metadata coming that indicates the specific code table (like titles in this example?)

{

"id": 884,

"available_field_name": "Title 1",

"value_type": "Lookup",

"one_to_many": false,

"output_sort_can_add_edit": true,

"criteria_can_add_edit": false,

"format_descriptor": "TableEntry"

}

  • Ben Lambert
  • Mar 13 2024
  • Attach files