Project

General

Profile

Bug #2525

Taxonomy controllers not documented

Added by Dominic Cleal almost 10 years ago. Updated almost 10 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
API
Target version:
Difficulty:
Triaged:
No
Bugzilla link:
Pull request:
Fixed in Releases:
Found in Releases:
Red Hat JIRA:

Description

The locations and organizations API controllers in APIv2 aren't documented in /apidoc.


Related issues

Related to Foreman - Bug #2658: Nightly installation does not work due to old apipie depClosed2013-06-12
Related to Foreman - Bug #2564: rake apipie:static throws exceptionClosed2013-05-26

Associated revisions

Revision 4fb88133 (diff)
Added by Ivan Necas almost 10 years ago

fixes #2525 - apipie documentation of actions defined in a concern

Apipie now supports defining actions defined in module by including
`Apipie::DSL::Concern`. Some substitutions are preformed while
including the documentation in each controller, so that instead of
paths like `/:resource_id/:id`, you get `/oraganizations/:id` or
`/locations/:id` respectively. Also param names and descriptions are
treated this way. See
https://github.com/pajk/apipie-rails#concerns for more details.

History

#1 Updated by Dominic Cleal almost 10 years ago

  • Status changed from New to Ready For Testing
  • Assignee set to Ivan Necas
  • Target version set to 1.2.0

#2 Updated by Ivan Necas almost 10 years ago

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

#3 Updated by Dominic Cleal almost 10 years ago

  • Target version changed from 1.2.0 to 1.3.0

Not merged into 1.2 due to regression in #2564.

Also available in: Atom PDF