{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/ba77f57b-02d1-3e26-99d6-40948a543c9c","info":{"title":"Crosswork AppManager API","description":"AppManager provides API methods for managing Crosswork applications that run on top of Kubernetes. This includes install-activate, deactivate, update, and uninstall for these applications. It also provides APIs to manage the internal package repository from which application installs are carried out.","version":"3.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/APP/app-overview.md"}},"openapi":"3.0.0","servers":[{"url":"/crosswork/platform/v2"}],"securitySchemes":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Bearer token for API authentication."}}},"spec":{"type":"object","properties":{"application_id":{"type":"string","title":"Immutable application id"},"version":{"type":"string","title":"Semantic version of Application containing Major.minor.patch, will be populated if application is active"},"install_id":{"type":"string","title":"unique install id per application"},"status":{"type":"string","enum":["UNKNOWN_STATE","INSTALLED","ACTIVE","INACTIVE","ACTIVATION_FAILED","DEACTIVATION_FAILED","INSTALL_FAILED","UNINSTALL_FAILED","UPDATE_FAILED","INSTALLING","ACTIVATING","DEACTIVATING","UNINSTALLING","UPDATING","UNINSTALLED","SKIPPED"],"default":"UNKNOWN_STATE","title":"Application status","example":"ACTIVE","$$ref":"#/components/schemas/app_managerStatus"},"progress":{"type":"number","format":"float","title":"Progress of transient state, if any"},"possible_actions":{"type":"array","items":{"type":"string","enum":["UNKNOWN_ACTION","INSTALL","ACTIVATE","DEACTIVATE","UPDATE","UNINSTALL","VIEW_APPLICATION_DETAILS","CONFIGURE"],"default":"UNKNOWN_ACTION","title":"Actions that can be performed on application","example":"ACTIVATE","$$ref":"#/components/schemas/app_managerApplicationAction"},"title":"Application actions that can be performed given the current state"},"available_updates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","title":"id"},"version":{"type":"string","title":"version"}},"title":"Repo app package identifier","example":{"id":"pkg1234","version":"1.0.0"},"$$ref":"#/components/schemas/app_managerPackageIdentifier"},"title":"list of available updates"},"pending_action":{"type":"object","properties":{"action":{"type":"string","enum":["UNKNOWN_ACTION","INSTALL","ACTIVATE","DEACTIVATE","UPDATE","UNINSTALL","VIEW_APPLICATION_DETAILS","CONFIGURE"],"default":"UNKNOWN_ACTION","title":"Actions that can be performed on application","example":"ACTIVATE","$$ref":"#/components/schemas/app_managerApplicationAction"},"job_id":{"type":"string","title":"job_id"}},"title":"Pending Action for Application","example":{"action":"INSTALL","job_id":"job1234"},"$$ref":"#/components/schemas/app_managerPendingApplicationAction"},"last_operation_error":{"type":"object","properties":{"message":{"type":"string","title":"Message is a textual description of reason for rejection, and can be safely passed on to operator through logs\nor UI"}},"title":"Error associated with an Object","example":{"message":"An error occurred due to invalid input."},"$$ref":"#/components/schemas/common_platformError"}},"title":"app_managerApplicationState","example":{"application_id":"app1234","version":"1.0.0","install_id":"install5678","status":"ACTIVE","progress":100,"possible_actions":["DEACTIVATE","UPDATE"],"available_updates":[],"pending_action":null,"last_operation_error":null},"$$ref":"#/components/schemas/app_managerApplicationState"}}