Skip to content

Expose inherit_from_id attribute in Integrations PUT API for Microsoft Teams

Proposal

Expose inherit_from_id attribute as a parameter in Integrations PUT API for Microsoft Teams: Create/Edit Microsoft Teams integration API, so it can be updated.

Customer use case

When there is already a Microsoft Teams configuration on the group level, configuring a new Microsoft Teams integration at a project level will Use default settings. The customer wishes to manage the project settings via API for the integration to Use custom settings (inherit_from_id = nil).

image

Excerpt from them:

we’re setting up all project settings via the API automatically based on a YAML configuration. When configuring this integration, it’s currently not working with the API, when there is already a configuration on group level. So our automatic approach is broken.

Current workaround

Use Rails console to set inherit_from_id as nil.

Technical details

To enable custom settings via API we have to upsert the API::Helpers::IntegrationsHelpers module.

E.g. into the 'microsoft-teams' we could add:

{
  required: false,
  name: :inherit_from_id,
  type: String,
  desc: 'The ID of ancestor'
},

with the change above, we will be able to set inherit_from_id value to nil, and update the rest of attributes.

Documentation

Documentation for this change needs to be added.

Edited by Magdalena Frankiewicz