apidoc internal 0.11.94

Internal models used in the implementation of apidoc

Resources

No resources

Headers

No headers

Imports

No imports

Enums

No enums

Models

task

Example Json: Minimal | Full
Field Type Required? Default Description
guid uuid Yes -

data task_data Yes -

number_attempts long No 0

Records the number of times we have attempted to run this task. Commonly we increment number attempts, process the task, and if succeeds we then delete the task. If it fails, we update last_error. This allows us to retry a task say twice; after which we no longer process the task (can notify an admin of the error).

last_error string No -

task_data_diff_version

Example Json: Minimal | Full
Field Type Required? Default Description
old_version_guid uuid Yes -

new_version_guid uuid Yes -

task_data_index_application

Example Json: Minimal | Full
Field Type Required? Default Description
application_guid uuid Yes -

Unions

task_data

Example Json: Minimal | Full
  • Type discriminator: N/A
task_data_index_application

Task to update the search index following a change in application

task_data_diff_version

Task triggered whenever a version changes. Diffs the service to record what actually changed