Fixes #38315 - Delay documentation of host status types #10494
Conversation
ofedoren
force-pushed
the
bug-38315-missing-status-types
branch
from
6d0040f to
97f785f
Compare
|
I likevthe idea but do you intend to submit it to apipie or keep it in here? |
I think it's better to live here, since it's quite custom. Not sure how could I generalize this to submit to Apipie-rails. |
ekohl
left a comment
ekohl
left a comment
There was a problem hiding this comment.
I considered wrapping the block in a specific class so you could distinguish between a regular callable and a callable that's an enum. But I can see your argument that it's rather specific and going to be messy so I won't object to merging it here.
| api :GET, "/hosts/:id/status/:type", N_("Get status of host") | ||
| param :id, :identifier_dottable, :required => true | ||
| param :type, [HostStatus::Global] + HostStatus.status_registry.to_a.map { |s| s.humanized_name }, :required => true, :desc => N_( | ||
| param :type, :delayed_enum, of: -> { [HostStatus::Global.status_name.underscore] + HostStatus.status_registry.to_a.map { |s| s.humanized_name } }, required: true, desc: N_( |
There was a problem hiding this comment.
The desc is now autogenerated so can we drop this?
There was a problem hiding this comment.
I guess so, dropped. I think the only benefit of such description is that it should be translated.
| api :DELETE, "/hosts/:id/status/:type", N_("Clear sub-status of host") | ||
| param :id, :identifier_dottable, :required => true | ||
| param :type, HostStatus.status_registry.to_a.map { |s| s.humanized_name }, :required => true, :desc => N_( | ||
| param :type, :delayed_enum, of: -> { HostStatus.status_registry.to_a.map { |s| s.humanized_name } }, required: true, desc: N_( |
There was a problem hiding this comment.
Same here: can we drop the description and rely on the generated one?
config/initializers/apipie.rb
Outdated
| end | ||
| end | ||
|
|
||
| class DelayedEnumValidator < Apipie::Validator::BaseValidator |
There was a problem hiding this comment.
Bike shedding: CallableEnumValidator?
ofedoren
force-pushed
the
bug-38315-missing-status-types
branch
from
97f785f to
9eb6ef2
Compare
config/initializers/apipie.rb
Outdated
| end | ||
| end | ||
|
|
||
| class DelayedEnumValidator < Apipie::Validator::BaseValidator |
| api :GET, "/hosts/:id/status/:type", N_("Get status of host") | ||
| param :id, :identifier_dottable, :required => true | ||
| param :type, [HostStatus::Global] + HostStatus.status_registry.to_a.map { |s| s.humanized_name }, :required => true, :desc => N_( | ||
| param :type, :delayed_enum, of: -> { [HostStatus::Global.status_name.underscore] + HostStatus.status_registry.to_a.map { |s| s.humanized_name } }, required: true, desc: N_( |
There was a problem hiding this comment.
I guess so, dropped. I think the only benefit of such description is that it should be translated.
ekohl
left a comment
ekohl
left a comment
There was a problem hiding this comment.
On my phone now so can't verify it but code reads well
2 participants
@ekohl, you might be interested in this, since it's basically an alternative to Apipie/apipie-rails#946. I don't even know myself how we didn't try this earlier :/ The new validator probably could be re-used in Katello or wherever similar places we have.
Before:
After:
