+ body={{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","nullable":true,"description":"The title of the integration. This will be displayed in the [data-sources page](https://app.getport.io/settings/data-sources) of your Port account."},"installationAppType":{"type":"string","description":"The name of the integrated tool/platform (e.g. `kubernetes`,`pagerduty`)."},"version":{"type":"string","description":"The version of the integration."},"spec":{"type":"object","additionalProperties":true},"actionsProcessingEnabled":{"type":"boolean","description":"If `true`, This integration will be able to process actions runs","default":false},"config":{"type":["object","null"],"additionalProperties":true,"description":"Various configuration options for the integration.","properties":{"deleteDependentEntities":{"type":"boolean","description":"If `true`, deleting an entity will also delete its dependent entities."},"createMissingRelatedEntities":{"type":"boolean","description":"If `true`, creating an entity with a relation to a non-existing entity will also create the related entity."},"resources":{"type":"array","description":"The mapping definition of resources from the integrated tool/platform into Port. For more information and examples, check out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-mapping).","items":{"type":"object","required":["kind","selector","port"],"properties":{"kind":{"type":"string","description":"The kind of resource to map, as defined in API of the integrated tool/platorm."},"selector":{"type":"object","properties":{"query":{"type":"string","description":"A `jq` query used to specify which resources to fetch from the integrated tool/platform. If set to `\"true\"`, all resources of the specified `kind` will be ingested. For more information and examples, check out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-mapping#how-does-mapping-work)."}}},"port":{"type":"object","required":["entity"],"description":"An object containing the mapping definitions of the `kind` resource into Port.","properties":{"entity":{"type":"object","required":["mappings"],"properties":{"mappings":{"description":"The mapping definitions used to map the resource fields into Port entities. For more information and examples, check out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-mapping#configuration-structure).","oneOf":[{"type":"array","title":"array","items":{"type":"object","required":["identifier","blueprint"],"properties":{"identifier":{"oneOf":[{"type":"string","title":"String identifier","description":"A `jq` expression used to get data from the integrated tool's API, to be used as an identifier for the entity."},{"type":"object","title":"Search query identifier","description":"A search query to define the entity's identifier based on a property of the entity.<br/>Read more [here](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-mapping#map-by-property).","properties":{"combinator":{"type":"string"},"rules":{"type":"array","items":{"type":"object","additionalProperties":true}}},"additionalProperties":false,"required":["combinator","rules"]}]},"title":{"type":"string","description":"A `jq` expression used to get data from the integrated tool's API, to be used as the title of the entity."},"blueprint":{"type":"string","description":"The identifier of the blueprint to map the data into."},"properties":{"type":"object","additionalProperties":true,"description":"An object containing the properties of the entity and their values. For more information and examples, check out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-mapping#configuration-structure)."},"relations":{"type":"object","additionalProperties":true,"description":"An object containing the relations of the entity and their values. For more information and examples, check out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-mapping#configuration-structure)."}}}},{"type":"object","required":["identifier","blueprint"],"properties":{"identifier":{"oneOf":[{"type":"string","title":"String identifier","description":"A `jq` expression used to get data from the integrated tool's API, to be used as an identifier for the entity."},{"type":"object","title":"Search query identifier","description":"A search query to define the entity's identifier based on a property of the entity.<br/>Read more [here](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-mapping#map-by-property).","properties":{"combinator":{"type":"string"},"rules":{"type":"array","items":{"type":"object","additionalProperties":true}}},"additionalProperties":false,"required":["combinator","rules"]}]},"title":{"type":"string","description":"A `jq` expression used to get data from the integrated tool's API, to be used as the title of the entity."},"blueprint":{"type":"string","description":"The identifier of the blueprint to map the data into."},"properties":{"type":"object","additionalProperties":true,"description":"An object containing the properties of the entity and their values. For more information and examples, check out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-mapping#configuration-structure)."},"relations":{"type":"object","additionalProperties":true,"description":"An object containing the relations of the entity and their values. For more information and examples, check out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-mapping#configuration-structure)."}},"title":"object"}]}}}}}}}}}},"changelogDestination":{"type":"object","description":"The destination of the integration's changelog.","properties":{"type":{"type":"string","enum":["WEBHOOK","KAFKA"]}},"oneOf":[{"type":"object","properties":{},"additionalProperties":false},{"type":"object","title":"Kafka","description":"The changelog will be sent to the Kafka topic connected to your Port account.","properties":{"type":{"type":"string","enum":["KAFKA"]}},"required":["type"],"additionalProperties":false},{"type":"object","title":"Webhook","description":"The changelog will be sent to the specified webhook.","properties":{"type":{"type":"string","enum":["WEBHOOK"]},"agent":{"type":"boolean","description":"If `true`, Port's execution agent will be used to send the changelog."},"url":{"type":"string","format":"uri","description":"The URL of the webhook."}},"required":["url","type"],"additionalProperties":false}]}},"additionalProperties":true}}}}}
0 commit comments