Project

General

Profile

Feature #34643

Turn off caching for apipie in production

Added by Eric Helms 3 months ago. Updated 2 months ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
API
Target version:
-
Difficulty:
Triaged:
No
Bugzilla link:
Fixed in Releases:
Found in Releases:

Related issues

Blocks Foreman - Tracker #34639: Stop generating api-pie cache and rely on dynamic generation of API docsClosed

Associated revisions

Revision 692bb8bd (diff)
Added by Eric Helms 2 months ago

Fixes #34643 - Do not use Apipie cache

This makes a change in production away from using an Apipie cache,
and instead relying on HTML docs and JSON being generated on demand.
Testing has found that they are roughly equivalent in load times,
and solve a larger issue where the docs can present incorrect
information when cached. There are places inside the code where
docs are generated conditionally based on runtime configuration
that can lead to incorrect docs. By switching to on-demand, the Apipie
documentation can accurately reflect the state of the running machine
and the development and production environments get closer in alignment.

History

#1 Updated by Eric Helms 3 months ago

  • Blocks Tracker #34639: Stop generating api-pie cache and rely on dynamic generation of API docs added

#2 Updated by The Foreman Bot 3 months ago

  • Assignee set to Eric Helms
  • Status changed from New to Ready For Testing
  • Pull request https://github.com/theforeman/foreman/pull/9165 added

#3 Updated by The Foreman Bot 2 months ago

  • Fixed in Releases 3.3.0 added

#4 Updated by Eric Helms 2 months ago

  • Status changed from Ready For Testing to Closed

#5 Updated by Amit Upadhye 2 months ago

  • Category set to API

Also available in: Atom PDF