Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #34381 - Change example for --order #9085

Merged
merged 1 commit into from Feb 3, 2022

Conversation

adiabramovitch
Copy link
Contributor

No description provided.

@theforeman-bot
Copy link
Member

Issues: #34381

@ofedoren ofedoren changed the title Refs #34381 - Change example for --order Fixes #34381 - Change example for --order Feb 2, 2022
@ezr-ondrej
Copy link
Member

@ofedoren do you wanna take this one? :)

@ofedoren
Copy link
Member

ofedoren commented Feb 2, 2022

@ezr-ondrej, of course, forgot to assign myself.

@ofedoren ofedoren self-assigned this Feb 2, 2022
Copy link
Member

@ofedoren ofedoren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @adiabramovitch! LGTM.

Could you please open a CP against 3.1-stable?

@ofedoren ofedoren merged commit 25c2497 into theforeman:develop Feb 3, 2022
@ofedoren
Copy link
Member

ofedoren commented Feb 7, 2022

CP 3.1: 9d3e3d3

@@ -18,7 +18,7 @@ class BaseController < Api::BaseController

def_param_group :search_and_pagination do
param :search, String, :desc => N_("filter results")
param :order, String, :desc => N_("Sort and order by a searchable field, e.g. 'id DESC'")
param :order, String, :desc => N_("Sort and order by a searchable field, e.g. '<field> DESC'")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ofedoren, @adiabramovitch I believe this is parsed by Maruku and it complains quite loudly:

| Maruku tells you:
+---------------------------------------------------------------------------
| Maruku cannot parse this block of HTML/XML:
| |<field> DESC'
| Missing end tag for 'field' (got 'html')
| Line: 4
| Position: 172
| Last 80 unconsumed characters:
+---------------------------------------------------------------------------
!/home/oezr/.rbenv/versions/2.7.4/lib/ruby/gems/2.7.0/gems/maruku-0.7.3/lib/maruku/helpers.rb:72:in `rescue in md_html'
!/home/oezr/.rbenv/versions/2.7.4/lib/ruby/gems/2.7.0/gems/maruku-0.7.3/lib/maruku/helpers.rb:67:in `md_html'
!/home/oezr/.rbenv/versions/2.7.4/lib/ruby/gems/2.7.0/gems/maruku-0.7.3/lib/maruku/input/parse_span.rb:513:in `read_inline_html'
!/home/oezr/.rbenv/versions/2.7.4/lib/ruby/gems/2.7.0/gems/maruku-0.7.3/lib/maruku/input/parse_span.rb:115:in `read_span'
\___________________________________________________________________________

Wrapping bad html in a PRE with class 'markdown-html-error'
|<field> DESC'

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, we have bunch of these already anyway :/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well... this is the only one I have in my develop setup currently.
Isn't there a way to escape this for Maruku not to read it as HTML tag?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly, didn't look at this yet :/ We have a redmine issue [1] to track such warnings.

[1] - https://projects.theforeman.org/issues/31889

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants