Project

General

Profile

Actions

Bug #6480

closed

syntax error in content_view_filter API docs causes apipie:cache warnings

Added by Martin Bacovsky over 9 years ago. Updated over 5 years ago.

Status:
Closed
Priority:
Normal
Category:
-
Target version:
Difficulty:
trivial
Triaged:
Yes
Fixed in Releases:
Found in Releases:

Description

Cloned from https://bugzilla.redhat.com/show_bug.cgi?id=1115836
Description of problem:

rake apipie:cache produces following warnings | Maruku tells you:
+------------------------------------------------------------------------- | Could not find ref_id = "security, bugfix, enhancement" for md_link([ | md_entity("lsquo"), | "security", | md_entity("rsquo"), | ", ", | md_entity("lsquo"), | "bugfix", | md_entity("rsquo"), | ", ", | md_entity("lsquo"), | "enhancement", | md_entity("rsquo") | ], nil) | Available refs are []
+-------------------------------------------------------------------------
!/home/mbacovsk/.gem/ruby/gems/maruku-0.7.1/lib/maruku/output/to_html.rb:656:in `to_html_link'
!/home/mbacovsk/.gem/ruby/gems/maruku-0.7.1/lib/maruku/output/to_html.rb:891:in `block in array_to_html'
!/home/mbacovsk/.gem/ruby/gems/maruku-0.7.1/lib/maruku/output/to_html.rb:879:in `each'
!/home/mbacovsk/.gem/ruby/gems/maruku-0.7.1/lib/maruku/output/to_html.rb:879:in `array_to_html'
\___________________________________________________________________________


Not creating a link for ref_id = "security, bugfix, enhancement".

The cause for this is syntax error in API docs

Version-Release number of selected component (if applicable):
Nightly

How reproducible:
Always

Steps to Reproduce:
1. run apipie:cache
2.
3.

Actual results:
warnings

Expected results:
no warnings

Additional info:
diff --git a/app/controllers/katello/api/v2/content_view_filters_controller.rb b/app/controllers/katello/api/v2/content_view_filters_controller.rb
index 961e679..28bfe22 100644
--- a/app/controllers/katello/api/v2/content_view_filters_controller.rb
++ b/app/controllers/katello/api/v2/content_view_filters_controller.rb
@ -84,7 +84,7 @ class Api::V2::ContentViewFiltersController < Api::V2::ApiController
N_("Get errata that are available to be added to the filter")
param :content_view_id, :identifier, :desc => N_("content view identifier")
param :id, :identifier, :desc => N_("filter identifier"), :required => true
- param :types, Array, :desc => N_("Errata types array ['security', 'bugfix', 'enhancement']")
param :types, Array, :desc => N_("Errata types array \\['security', 'bugfix', 'enhancement'\\]")
param :start_date, DateTime, :desc => N_("Start date that Errata was issued on to filter by")
param :end_date, DateTime, :desc => N_("End date that Errata was issued on to filter by")
def available_errata
[

Actions #1

Updated by Martin Bacovsky over 9 years ago

  • Category set to API
Actions #2

Updated by Martin Bacovsky over 9 years ago

  • Status changed from New to Ready For Testing
Actions #4

Updated by Dominic Cleal over 9 years ago

  • Project changed from Foreman to Katello
  • Category changed from API to 106
  • Triaged set to No
Actions #5

Updated by Anonymous over 9 years ago

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

Updated by Eric Helms over 9 years ago

  • Target version set to 49
  • Difficulty set to trivial
  • Triaged changed from No to Yes
Actions #7

Updated by Eric Helms over 9 years ago

  • translation missing: en.field_release set to 13
Actions

Also available in: Atom PDF