Updates

GET

api/updates

Получение списка патчей

Запрос

Параметры запроса:

Name	In	Type	Description
where (Optional)	url parameters	JSON object	Фильтр элементов. Используется синтаксис mongo запросов.
sort (Optional)	url parameters	string	Сортировка элементов.
projection (Optional)	url parameters	JSON object	Скрытие полей.
embedded (Optional)	url parameters	JSON object	Встраивание элементов в поля.
page (Optional)	url parameters	integer	Номер страницы элементов.
max_results (Optional)	url parameters	integer	Максимальное число элементов на одной странице.

Пример запроса:

curl -X GET http://tkcontrol/api/updates

Ответ

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

{
    "_items": [
        {
            "_id": "5eb54eb4f0e593e6ec94f3ac",
            "name": "add-grain.sls",
            "text": "some sls file",
            "_updated": "Fri, 08 May 2020 12:21:08 GMT",
            "_created": "Fri, 08 May 2020 12:21:08 GMT",
            "_links": {
                "self": {
                    "title": "Update",
                    "href": "updates/5eb54eb4f0e593e6ec94f3ac"
                }
            }
        },
        {
            "_id": "5eb54eb4f0e593e6ec94f3ad",
            "name": "patch-1.sls",
            "text": "some patch",
            "_updated": "Fri, 08 May 2020 12:21:08 GMT",
            "_created": "Fri, 08 May 2020 12:21:08 GMT",
            "_links": {
                "self": {
                    "title": "Update",
                    "href": "updates/5eb54eb4f0e593e6ec94f3ad"
                }
            }
        },
    ],
    "_links": {
        "parent": {
            "title": "home",
            "href": "/"
        },
        "self": {
            "title": "updates",
            "href": "updates"
        },
        "next": {
            "title": "next page",
            "href": "updates?page=2"
        },
        "last": {
            "title": "last page",
            "href": "updates?page=2"
        }
    },
    "_meta": {
        "page": 1,
        "max_results": 25,
        "total": 2
    }
}

GET

/api/updates/{id}

Получение патча по id

Запрос

Параметры запроса:

Name	In	Type	Description
projection (Optional)	url parameters	JSON object	Скрытие полей.
embedded (Optional)	url parameters	JSON object	Встраивание элементов в поля.

Пример запроса:

curl -X GET http://tkcontrol/api/updates/5eb54eb4f0e593e6ec94f3ac

Ответ

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

{
    "_id": "5eb54eb4f0e593e6ec94f3ac",
    "name": "add-grain.sls",
    "text": "some sls file",
    "_updated": "Fri, 08 May 2020 12:21:08 GMT",
    "_created": "Fri, 08 May 2020 12:21:08 GMT",
    "_links": {
        "self": {
            "title": "Update",
            "href": "updates/5eb54eb4f0e593e6ec94f3ac"
        },
        "parent": {
        "title": "home",
            "href": "/"
        },
      "collection": {
            "title": "updates",
            "href": "updates"
        }
    }
}

POST

/api/updates

Загрузить патчи из saltmaster

Запрос

Пример запроса:

curl -X POST http://tkcontrol/api/updates

PATCH

/api/updates/{id}

Изменить локально патч по id

Запрос

Пример запроса:

curl -X PATCH http://tkcontrol/api/updates/5eb54eb4f0e593e6ec94f3ad -H "Content-Type: application/json" -d '{ \
     { \
         "description": "First patch" \
     }'