Feature #4478

API docs need to be localized

Added by Tomáš Strachota over 3 years ago. Updated over 2 years ago.

Status:Closed
Priority:High
Assigned To:Martin Bacovsky
Category:API
Target version:Sprint 30
Difficulty: Bugzilla link:
Found in release: Pull request:https://github.com/theforeman/foreman/pull/1626
Story points-
Velocity based estimate-
Release1.8.0Release relationshipAuto

Description

We reuse information from api docs to build the CLI. Therefore we need to localize the api docs and find a way how to distribute it to the clients. Dynamic bindings should help with this. It will also probably require support on the ApiPie side.


Related issues

Related to Hammer CLI - Feature #3666: i18n support Closed 11/15/2013
Related to Foreman - Bug #6864: APIv2 error messages not extracted Closed 07/31/2014
Related to Foreman - Bug #9775: CR encryption key not loaded before it's checked, encrypt... Closed 03/16/2015
Related to Foreman - Bug #9973: apipie doc string substitutions not working Closed 03/31/2015
Related to Foreman - Bug #10336: foreman-rake prints "Workaround for RbVmomi may not work ... Closed 04/30/2015

Associated revisions

Revision 340df402
Added by Martin Bačovský over 3 years ago

Refs #4478 - support for API lacalization

Revision ad52b0f0
Added by Tomas Strachota over 3 years ago

Merge pull request #119 from mbacovsky/4478_localized_api

Refs #4478 - support for API lacalization

Revision 2656873b
Added by Martin Bačovský over 3 years ago

Refs #4478 - API doc strings marked for translation

Revision a59972c3
Added by Martin Bačovský about 3 years ago

Fixes #4478 - API documentation localized

Revision fa24d7a1
Added by Martin Bačovský over 2 years ago

Refs #4478 - copy in pre-built plugin caches on rake apipie:cache index

Revision 44c190a4
Added by Martin Bacovsky over 2 years ago

Refs #4478 - prebuild localized apipie cache

Revision 5e97d3c3
Added by Martin Bacovsky over 2 years ago

Refs #4478 - prebuild apipie cache for rubygem-foreman_discovery

Revision 65521ed3
Added by Tom Caspy over 2 years ago

Refs #4478 - Remove empty line in apipie.rake

History

#1 Updated by Tomáš Strachota over 3 years ago

#2 Updated by Martin Bacovsky over 3 years ago

  • Tracker changed from Feature to Tracker
  • Status changed from New to Assigned
  • Assigned To set to Martin Bacovsky
  • Target version set to Sprint 22

- localize apidoc strings
- fix apipie-rails to support localized docs
- fix apipie-bindings to work with localized docs
- resolve performance problem with generating cache for multiple languages
- fix hammer to use localized bindings

#3 Updated by The Foreman Bot over 3 years ago

  • Status changed from Assigned to Ready For Testing

#4 Updated by Dominic Cleal over 3 years ago

  • Tracker changed from Tracker to Feature

#5 Updated by The Foreman Bot over 3 years ago

  • Pull request https://github.com/theforeman/foreman/pull/1626 added

#6 Updated by Dominic Cleal over 3 years ago

  • Target version changed from Sprint 22 to Sprint 27

#7 Updated by Dominic Cleal over 3 years ago

  • Related to Bug #6864: APIv2 error messages not extracted added

#8 Updated by Dmitri Dolguikh about 3 years ago

  • Target version changed from Sprint 27 to Sprint 28

#9 Updated by Dmitri Dolguikh about 3 years ago

  • Target version changed from Sprint 28 to Sprint 29

#10 Updated by Dominic Cleal about 3 years ago

  • Target version changed from Sprint 29 to Sprint 30

#11 Updated by Anonymous about 3 years ago

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

#12 Updated by Dominic Cleal about 3 years ago

  • Release set to 1.8.0

#14 Updated by Dominic Cleal over 2 years ago

  • Related to Bug #9775: CR encryption key not loaded before it's checked, encryption is disabled added

#15 Updated by Dominic Cleal over 2 years ago

  • Related to Bug #9973: apipie doc string substitutions not working added

#16 Updated by Dominic Cleal over 2 years ago

  • Related to Bug #10336: foreman-rake prints "Workaround for RbVmomi may not work as ComputeResource is already loaded: #{ComputeResource}" added

Also available in: Atom PDF