Project

General

Profile

Actions

Bug #22753

closed

Some API parameters are wrongly documented as enum types

Added by Tomáš Strachota about 6 years ago. Updated over 5 years ago.

Status:
Closed
Priority:
Normal
Category:
API
Target version:
Difficulty:
Triaged:
Fixed in Releases:
Found in Releases:

Description

There are several params in the apidoc that are wrongly documented as enum types. Authors most likely intended to validate the parameter for multiple allowed values, but apipie interprets the array syntax as enum.
E.g.:

param :value, LookupKey::KEY_TYPES # -> [ string, boolean, integer, real, array, hash, yaml, json ]

As a result hammer validates such options and raises an exception if ti contains values other than enumerated, which makes the commands unusable.


Related issues 3 (0 open3 closed)

Related to Hammer CLI - Bug #22751: Adding override values doesn't work with 1.17ClosedTomáš Strachota03/02/2018Actions
Related to Foreman - Bug #17087: Updating default_value of a hash/array smart class parameter with a non string value should return an error messageClosedOri Rabin10/25/2016Actions
Related to Katello - Bug #22754: Content view filter rule name param is wrongly documented as enumClosedTomáš Strachota03/02/2018Actions
Actions #1

Updated by The Foreman Bot about 6 years ago

  • Status changed from New to Ready For Testing
  • Assignee set to Tomáš Strachota
  • Pull request https://github.com/theforeman/foreman/pull/5286 added
Actions #2

Updated by Tomáš Strachota about 6 years ago

  • Related to Bug #22751: Adding override values doesn't work with 1.17 added
Actions #3

Updated by Tomáš Strachota about 6 years ago

  • Related to Bug #17087: Updating default_value of a hash/array smart class parameter with a non string value should return an error message added
Actions #4

Updated by Tomáš Strachota about 6 years ago

  • Related to Bug #22754: Content view filter rule name param is wrongly documented as enum added
Actions #5

Updated by Anonymous about 6 years ago

  • Status changed from Ready For Testing to Closed
  • % Done changed from 0 to 100
Actions #6

Updated by Ivan Necas about 6 years ago

  • translation missing: en.field_release set to 330
Actions

Also available in: Atom PDF