{"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":{"unit_id":{"type":"string","title":"Immutable Unique application identifier"},"version":{"type":"string","title":"Semantic version of Application containing Major.minor.patch"},"description":{"type":"string","title":"Description of pod,resource"},"summary":{"type":"object","properties":{"name":{"type":"string","title":"Immutable Unique application identifier"},"description":{"type":"string","title":"Description of application"}},"title":"Summary - marketing data","example":{"name":"Example App","description":"This is a sample application"},"$$ref":"#/components/schemas/app_managerSummary"},"identifier_Type":{"type":"string","enum":["UNKNOWN_IDENTIFIER_TYPE","APPLICATION","POD","RESOURCE"],"default":"UNKNOWN_IDENTIFIER_TYPE","description":"- APPLICATION: Composite package\n - POD: Executable package\n - RESOURCE: Physical file","title":"Identifier type","example":"APPLICATION","$$ref":"#/components/schemas/app_managerIdentifierType"},"category":{"type":"string","enum":["UNKNOWN_CATEGORY","EXTERNAL_APP","PLATFORM"],"default":"UNKNOWN_CATEGORY","description":"- EXTERNAL_APP: INTERNAL_APP = 1; reserved\n - PLATFORM: INFRA","title":"App Object Category to indicate whether it app is external app or an internal app or platform","example":"EXTERNAL_APP","$$ref":"#/components/schemas/app_managerCategory"},"dependency_constraints":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","title":"identifier object ,cannot contain only alphabets _"},"identifier_type":{"type":"string","enum":["UNKNOWN_IDENTIFIER_TYPE","APPLICATION","POD","RESOURCE"],"default":"UNKNOWN_IDENTIFIER_TYPE","description":"- APPLICATION: Composite package\n - POD: Executable package\n - RESOURCE: Physical file","title":"Identifier type","example":"APPLICATION","$$ref":"#/components/schemas/app_managerIdentifierType"},"version_range":{"type":"string","title":"examples of valid range - \"\u003c1.0.0\",\"\u003c=1.0.0\",\"\u003e1.0.0\",\"\u003e=1.0.0\",\"1.0.0\", \"=1.0.0\",\"\u003e=1.0.0 \u003c=2.0.0\" or \"*\" indicating all versions is exceptable"}},"description":"constraint stanza defines rules for how a direct dependency must be incorporated into the dependency graph.","example":{"id":"constraint123","identifier_type":"APPLICATION","version_range":"\u003e=1.0.0 \u003c2.0.0"},"$$ref":"#/components/schemas/app_managerConstraint"},"title":"List of Dependencies"},"build_information":{"type":"object","properties":{"date_time":{"type":"string","title":"Date on which image was built in RFC339 format"},"publisher":{"type":"string","title":"Publisher information"}},"title":"Build Information","example":{"date_time":"2023-09-01T12:00:00Z","publisher":"Cisco Systems"},"$$ref":"#/components/schemas/app_managerBuildInformation"},"meta_schema_version":{"type":"string","title":"Schema Spec version"},"skip_auto_install":{"type":"boolean","title":"Skip auto install"},"runtime_type":{"type":"string","enum":["UNKNOWN_DEPLOYMENT_RUNTIME_TYPE","BUILD_TIME","DYNAMIC"],"default":"UNKNOWN_DEPLOYMENT_RUNTIME_TYPE","description":"- UNKNOWN_DEPLOYMENT_RUNTIME_TYPE: Unknown runtime type\n - BUILD_TIME: Static deployment\n - DYNAMIC: Dynamic deployment","title":"DeploymentRunTimeType - Type of deployment runtime","example":"DYNAMIC","$$ref":"#/components/schemas/app_managerDeploymentRunTimeType"}},"title":"app_managerDeploymentUnit","example":{"unit_id":"unit1234","version":"1.0.0","description":"This is a deployment unit for XYZ functionality.","summary":{"name":"Unit Name","description":"Unit Description"},"identifier_Type":"POD","category":"EXTERNAL_APP","dependency_constraints":[],"build_information":{"date_time":"2023-09-01T12:00:00Z","publisher":"Cisco Systems"},"meta_schema_version":"v1","skip_auto_install":false,"runtime_type":"DYNAMIC"},"$$ref":"#/components/schemas/app_managerDeploymentUnit"}}