getRepositoryPrebuilts

{ "queryOptions": { "page": 1, "order": 1, "iap_version": 2020.1, "search": "nso", "config": "@itentialopensource", "versionStatus": "current" } }

{ "type": "object", "properties": { "queryOptions": { "title": "queryOptions", "type": "object", "properties": { "page": { "$id": "#/properties/page", "type": "integer", "description": "The page number for the request return. Used for pagination.", "default": 1, "minimum": 1, "examples": [ 1, 3, 5 ] }, "order": { "$ref": "common-schema#/definitions/order" }, "iap_version": { "type": "number", "description": "The version of IAP. Can be used to overwrite the release version of artifacts in the response.", "examples": [ 2019.3, 2020.1 ] }, "search": { "type": "string", "description": "Search all available artifacts to find a match related to the provided query.", "examples": [ "device", "nso" ] }, "config": { "$ref": "common-schema#/definitions/config" }, "versionStatus": { "type": "string", "description": "Filter the list of Pre-builts based on the available version of the Pre-built in comparison to the current version of IAP", "enum": [ "latest", "current" ] } } } }, "required": [ "queryOptions" ], "additionalProperties": false }

{ "results": [ { "versionStatus": { "status": "current", "iap_version": "release/2020.1" }, "installStatus": { "installable": false, "mismatchingDependencies": null }, "availableUpdate": null, "name": "@itentialopensource/cisco-nx-upgrade", "version": "0.0.1", "description": "A basic description", "author": "Itential Artifacts", "published": "2020-04-09T17:44:30.215Z", "repository": { "type": "gitlab", "hostname": "localhost", "path": "/itentialopensource/pre-built-automations" }, "license": "Apache-2.0", "keywords": [ "Itential", "Itential", "Itential", "Itential", "Itential" ], "readme": "example of readme", "download": { "metadata": { "name": "@itentialopensource/cisco-nx-upgrade", "version": "0.1.0", "description": "A basic description", "author": "Itential Artifacts", "license": "Apache-2.0", "repository": { "type": "git", "hostname": "localhost", "path": "/itentialopensource/pre-built-automations" }, "keywords": [ "Itential", "Itential", "Itential", "Itential", "Itential" ], "gitlabId": 17866482 }, "manifest": { "bundleName": "aggregateFunctions", "artifacts": [ { "id": "5e5ea3bd16da51d52b4a8f9f", "name": "aggregateFunctions", "type": "template", "location": "/bundles/workflows/IAP Test Artifact Workflow.json" }, { "id": "5e5ea3bd16da51d52b4a8f9f", "name": "aggregateFunctions", "type": "golden-config", "location": "/bundles/workflows/IAP Test Artifact Workflow.json" } ], "fingerprint": "5e84f892c5eab11ec2eee16d", "createdEpoch": "1585772690392" }, "bundles": [ { "type": "workflow" }, { "type": "json-forms" }, { "type": "workflow" }, { "type": "mop-template" } ], "readme": "example of readme" } }, { "versionStatus": { "status": "current", "iap_version": "release/2020.1" }, "installStatus": { "installable": true, "mismatchingDependencies": null }, "availableUpdate": true, "name": "@itentialopensource/aggregate-functions-for-arrays", "version": "1.1.1-2020.1.0", "description": "A basic description", "author": "Itential Artifacts", "published": "2020-04-09T17:44:30.215Z", "repository": { "type": "gitlab", "hostname": "gitlab.com", "path": "/itentialopensource/pre-built-automations" }, "license": "Apache-2.0", "keywords": [ "Itential", "Itential", "Itential", "Itential", "Itential" ], "readme": "example of readme", "download": { "metadata": { "name": "@itentialopensource/cisco-nx-upgrade", "version": "1.0.0", "description": "A basic description", "author": "Itential Artifacts", "license": "Apache-2.0", "repository": { "type": "local", "hostname": "localhost", "path": "/itentialopensource/pre-built-automations" }, "keywords": [ "Itential", "Itential" ], "gitlabId": 17866482 }, "manifest": { "bundleName": "aggregateFunctions", "artifacts": [ { "id": "5e5ea3bd16da51d52b4a8f9f", "name": "aggregateFunctions", "type": "transformation", "location": "/bundles/workflows/IAP Test Artifact Workflow.json" }, { "id": "5e5ea3bd16da51d52b4a8f9f", "name": "aggregateFunctions", "type": "workflow", "location": "/bundles/workflows/IAP Test Artifact Workflow.json" }, { "id": "5e5ea3bd16da51d52b4a8f9f", "name": "aggregateFunctions", "type": "integration", "location": "/bundles/workflows/IAP Test Artifact Workflow.json" }, { "id": "5e5ea3bd16da51d52b4a8f9f", "name": "aggregateFunctions", "type": "forms", "location": "/bundles/workflows/IAP Test Artifact Workflow.json" }, { "id": "5e5ea3bd16da51d52b4a8f9f", "name": "aggregateFunctions", "type": "workflow", "location": "/bundles/workflows/IAP Test Artifact Workflow.json" } ], "fingerprint": "5e84f892c5eab11ec2eee16d", "createdEpoch": "1585772690392" }, "bundles": [ { "type": "template" }, { "type": "service-catalog" } ], "readme": "example of readme" } } ], "total": 10, "page": 77155159, "total-pages": 92269520 }

{ "title": "results", "type": "object", "required": [ "results", "total" ], "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "versionStatus": { "type": "object", "properties": { "status": { "type": "string", "examples": [ "current" ] }, "iap_version": { "type": "string", "examples": [ "release/2020.1" ] } } }, "installStatus": { "type": "object", "properties": { "installable": { "type": "boolean", "enum": [ true, false ] }, "missingDependencies": { "oneOf": [ { "type": "object", "description": "A list of every dependency in the prebuilt that is missing from the running system." }, { "type": "null" } ] }, "mismatchingDependencies": { "oneOf": [ { "type": "object", "description": "A list of every dependency in the prebuilt that has a version greater than the version of the service running on the system." }, { "type": "null" } ] } } }, "availableUpdate": { "oneOf": [ { "type": "boolean", "enum": [ true, false ] }, { "type": "null" } ] }, "name": { "$ref": "prebuilts-schema#/definitions/name" }, "version": { "$ref": "prebuilts-schema#/definitions/version" }, "description": { "$ref": "prebuilts-schema#/definitions/description" }, "author": { "$ref": "prebuilts-schema#/definitions/author" }, "published": { "type": "string", "examples": [ "2020-04-09T17:44:30.215Z" ], "format": "date-time" }, "repository": { "$ref": "prebuilts-schema#/definitions/repository" }, "license": { "$ref": "prebuilts-schema#/definitions/license" }, "keywords": { "$ref": "prebuilts-schema#/definitions/keywords" }, "IAPDependencies": { "$ref": "prebuilts-schema#/definitions/IAPDependencies" }, "readme": { "$ref": "prebuilts-schema#/definitions/readme" }, "download": { "$ref": "prebuilts-schema" } } } }, "total": { "$ref": "common-schema#/definitions/total" }, "page": { "$id": "#/properties/page", "type": "integer" }, "total-pages": { "$id": "#/properties/total-pages", "type": "integer" } } }