Окружения

Описание структуры JSON-объекта, описывающего правило защиты окружений

Ознакомиться с работой правил защиты окружений возможно здесь.

Поле	Тип	Описание
`environmentTemplate`	String	Шаблон названия защищенного окружения
`ownerType`	String	Тип владельца правила защиты окружений
`allowToDeploy`	String	Минимальная роль участников, которым разрешено создание защищенных окружений. Возможные значения: `NO_ONE` - никому, `DEVELOPER` - разработчикам и выше, `ADMINS` - администраторам и выше
`uuid`	String	UUID правила защиты окружений

Методы для правил защиты окружений

Метод для получения списка правил защиты окружений

Метод доступен в Enterprise версии, а также на gitflic.ru

Компании: GET /company/{companyAlias}/environment-protection

Команды: GET /team/{teamAlias}/environment-protection

Запрос возвращает список правил защиты окружений указанной сущности с данным псевдонимом, есть возможность настройки количества отображаемых объектов на странице

Переменная пути запроса	Тип	Описание
`companyAlias`	String	Псевдоним компании
`teamAlias`	String	Псевдоним команды

Responses

STATUS 200 - Правила защиты окружений возвращены:

Пример ответа

    
{
    "_embedded": {
        "restEnvironmentProtectionModelList": [
            {
                "environmentTemplate": "**",
                "ownerType": "COMPANY",
                "allowToDeploy": "ADMINS",
                "uuid": "e7b6c8c8-aaaa-aaaa-aaaa-7b945816347f"
            },
            {
                "environmentTemplate": "feature-*",
                "ownerType": "COMPANY",
                "allowToDeploy": "DEVELOPER",
                "uuid": "6835a7c0-aaaa-aaaa-aaaa-1ced8aa44344"
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 2,
        "totalPages": 1,
        "number": 0
    }
}

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для получения правила защиты окружений по UUID

Метод доступен в Enterprise версии, а также на gitflic.ru

Компании: GET /company/{companyAlias}/environment-protection/{environmentProtectionUuid}

Команды: GET /team/{teamAlias}/environment-protection/{environmentProtectionUuid}

Запрос возвращает правило защиты окружений указанной сущности с данным псевдонимом по указанному UUID.

Переменная пути запроса	Тип	Описание
`companyAlias`	String	Псевдоним компании
`teamAlias`	String	Псевдоним команды
`environmentProtectionUuid`	String	UUID правила защиты окружений

Responses

STATUS 200 - Правило защиты окружений возвращено:

Пример ответа

    
{
    "environmentTemplate": "**",
    "ownerType": "COMPANY",
    "allowToDeploy": "ADMINS",
    "uuid": "e7b6c8c8-aaaa-aaaa-aaaa-7b945816347f"
}

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для создания правила защиты окружений

Метод доступен в Enterprise версии, а также на gitflic.ru

Компании: POST /company/{companyAlias}/environment-protection/create

Команды: POST /team/{teamAlias}/environment-protection/create

Запрос создает и возвращает правило защиты окружений для указанной сущности с данным псевдонимом.

Переменная пути запроса	Тип	Описание
`companyAlias`	String	Псевдоним компании
`teamAlias`	String	Псевдоним команды

Request

Поддерживаемый формат JSON

Структура тела POST-запроса:

Поле	Тип	Описание
`environmentTemplate`	String	Шаблон названия защищенного окружения
`allowToDeploy`	String	Кому разрешено создавать окружения. Возможные значения: `NO_ONE` - никому, `DEVELOPER` - разработчикам и выше, `ADMINS` - администраторам и выше

Пример JSON объекта

{
    "environmentTemplate": "**",
    "allowToDeploy": "ADMINS"
}

Responses

STATUS 200 - Правило защиты окружений создано:

Пример ответа

    
{
    "environmentTemplate": "**",
    "ownerType": "COMPANY",
    "allowToDeploy": "ADMINS",
    "uuid": "e7b6c8c8-aaaa-aaaa-aaaa-7b945816347f"
}

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

STATUS 422 - В теле запроса не указано обязательно поле.

Метод для изменения правила защиты окружений

Метод доступен в Enterprise версии, а также на gitflic.ru

Компании: PATCH /company/{companyAlias}/environment-protection/edit

Команды: PATCH /team/{teamAlias}/environment-protection/edit

Запрос изменяет и возвращает правило защиты окружений для указанной сущности с данным псевдонимом.

Переменная пути запроса	Тип	Описание
`companyAlias`	String	Псевдоним компании
`teamAlias`	String	Псевдоним команды

Request

Поддерживаемый формат JSON

Структура тела PATCH-запроса:

Поле	Тип	Описание
`uuid`	String	UUID правила защиты окружения
`allowToDeploy`	String	Кому разрешено создавать окружения. Возможные значения: `NO_ONE` - никому, `DEVELOPER` - разработчикам и выше, `ADMINS` - администраторам и выше

Пример JSON объекта

{
    "uuid": "e7b6c8c8-aaaa-aaaa-aaaa-7b945816347f",
    "allowToDeploy": "ADMINS"
}

Responses

STATUS 200 - Правило защиты окружений изменено:

Пример ответа

    
{
    "environmentTemplate": "**",
    "ownerType": "COMPANY",
    "allowToDeploy": "ADMINS",
    "uuid": "e7b6c8c8-aaaa-aaaa-aaaa-7b945816347f"
}

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

STATUS 422 - В теле запроса не указано обязательно поле.

Метод для удаления правила защиты окружений

Метод доступен в Enterprise версии, а также на gitflic.ru

Компании: DELETE /company/{companyAlias}/environment-protection/{environmentProtectionUuid}

Команды: DELETE /team/{teamAlias}/environment-protection/{environmentProtectionUuid}

Запрос удаляет правило защиты окружений указанной сущности с данным псевдонимом по указанному UUID.

Переменная пути запроса	Тип	Описание
`companyAlias`	String	Псевдоним компании
`teamAlias`	String	Псевдоним команды
`environmentProtectionUuid`	String	UUID правила защиты окружений

Responses

STATUS 204 - Правило защиты окружений удалено:

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для применения правил защиты окружений к проектам

Метод доступен в Enterprise версии, а также на gitflic.ru

Компании: POST /company/{companyAlias}/environment-protection/apply-settings-to-projects

Команды: POST /team/{teamAlias}/environment-protection/apply-settings-to-projects

Запрос применяет правила защиты окружений ко всем проектам указанной сущности с данным псевдонимом.

Переменная пути запроса	Тип	Описание
`companyAlias`	String	Псевдоним компании
`teamAlias`	String	Псевдоним команды

Responses

STATUS 204 - Правила защиты окружений применены ко всем дочерним проектам:

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.