Project

General

Profile

Actions

Refactor #29581

closed

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

Added by Tomer Brisker almost 4 years ago. Updated almost 4 years ago.

Status:
Rejected
Priority:
Normal
Assignee:
Category:
API
Target version:
-
Difficulty:
Triaged:
No
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 2 (0 open2 closed)

Related to Foreman - Feature #29564: Add nulldb supportDuplicateActions
Related to Foreman - Feature #17964: Extend apidoc with list of fields to use in a searchClosedTomáš Strachota01/06/2017Actions
Actions #1

Updated by Tomer Brisker almost 4 years ago

Actions #2

Updated by Tomer Brisker almost 4 years ago

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

Updated by The Foreman Bot almost 4 years ago

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

Updated by Tomer Brisker almost 4 years ago

  • Status changed from Ready For Testing to Rejected

Looks like it's better to keep empty.

Actions

Also available in: Atom PDF