Project

General

Profile

Refactor #29581

Default to string in api doc for search params where type cannot be deduced

Added by Tomer Brisker 5 months ago. Updated 5 months ago.

Status:
Rejected
Priority:
Normal
Assignee:
Category:
API
Target version:
-
Difficulty:
Triaged:
No
Bugzilla link:
Fixed in Releases:
Found in Releases:

Description

Api doc generation is not able to determine search parameter types when generated without a migrated database (e.g. with nulldb). These types aren't enforced and are always sent to the api as a string (as part of url parameters).
We can default to string value in this case as a safe fallback, and allow users to regenerate the apidoc manually if they require a more specific information (e.g. integer fields).


Related issues

Related to Foreman - Feature #29564: Add nulldb supportDuplicate
Related to Foreman - Feature #17964: Extend apidoc with list of fields to use in a searchClosed2017-01-06

History

#1 Updated by Tomer Brisker 5 months ago

#2 Updated by Tomer Brisker 5 months ago

  • Related to Feature #17964: Extend apidoc with list of fields to use in a search added

#3 Updated by The Foreman Bot 5 months ago

  • Assignee set to Tomer Brisker
  • Status changed from New to Ready For Testing
  • Pull request https://github.com/theforeman/foreman/pull/7598 added

#4 Updated by Tomer Brisker 5 months ago

  • Status changed from Ready For Testing to Rejected

Looks like it's better to keep empty.

Also available in: Atom PDF