Help:Public API - Revision history

Akuzmin: minor fixes

2025-11-27T10:42:05Z

minor fixes

← Older revision		Revision as of 13:42, 27 November 2025
Line 56:		Line 56:
	Этот пример работает только с python3 и не работает при аутентификации в Svacer через LDAP.		Этот пример работает только с python3 и не работает при аутентификации в Svacer через LDAP.

	Скачайте и распакуйте [[~~index.php?title=~~Media:~~Get link~~.zip\|get_link.zip]]		Скачайте и распакуйте [[Media:get_link.zip\|get_link.zip]]

	Запрос:		Запрос:
Line 301:		Line 301:
	==== Метод /api/public/projects/{project_id}/branch/{branch_id}/snapshots ====		==== Метод /api/public/projects/{project_id}/branch/{branch_id}/snapshots ====

	С помощью ~~данно~~ метода можно получить список снимков указанной ветки. Пример кода для получения снимков с именем <code>ver. 2.7.0*</code>		С помощью данного метода можно получить список снимков указанной ветки. Пример кода для получения снимков с именем <code>ver. 2.7.0*</code>

	<pre class="">from filters import *		<pre class="">from filters import *

Chernykov sv: /* Примеры использования фильтров в public api */

2025-11-27T09:46:47Z

Примеры использования фильтров в public api

← Older revision		Revision as of 12:46, 27 November 2025
Line 56:		Line 56:
	Этот пример работает только с python3 и не работает при аутентификации в Svacer через LDAP.		Этот пример работает только с python3 и не работает при аутентификации в Svacer через LDAP.

	Скачайте и распакуйте [[Media:~~get_link~~.zip\|get_link.zip]]		Скачайте и распакуйте [[index.php?title=Media:Get link.zip\|get_link.zip]]

	Запрос:		Запрос:
Line 149:		Line 149:
	Для проекта, ветки и снимка можно указать как имя так и ID. Имя можно указать с использованием регулярного выражения. ID необходимо указать полностью.		Для проекта, ветки и снимка можно указать как имя так и ID. Имя можно указать с использованием регулярного выражения. ID необходимо указать полностью.

	==== ~~Точка входа~~ /api/public/login ====		==== Метод /api/public/login ====

	Данный класс может быть использован для соединения с сервером Svacer. В данном модуле демонстрируется взаимодействие с ~~точкой входа~~ /api/public/login.		Данный класс может быть использован для соединения с сервером Svacer. В данном модуле демонстрируется взаимодействие с методом /api/public/login.

	<pre class="">import requests		<pre class="">import requests
Line 243:		Line 243:
	raise Exception(f"GET request failed: {e}")		raise Exception(f"GET request failed: {e}")
	</pre>		</pre>
	==== ~~Точка входа~~ /api/public/projects ====		==== Метод /api/public/projects ====

	В данном примере выводится в формате json список проектов, имя которых соответствует регулярному выражению <code>darpa*</code>		В данном примере выводится в формате json список проектов, имя которых соответствует регулярному выражению <code>darpa*</code>
Line 299:		Line 299:
	}		}
	]</pre>		]</pre>
	==== ~~Точка входа~~ /api/public/projects/{project_id}/branch/{branch_id}/snapshots ====		==== Метод /api/public/projects/{project_id}/branch/{branch_id}/snapshots ====

	С помощью ~~данной точки входа~~ можно получить список снимков указанной ветки. Пример кода для получения снимков с именем <code>ver. 2.7.0*</code>		С помощью данно метода можно получить список снимков указанной ветки. Пример кода для получения снимков с именем <code>ver. 2.7.0*</code>

	<pre class="">from filters import *		<pre class="">from filters import *
Line 403:		Line 403:
	}		}
	]</pre>		]</pre>
	==== ~~Точка входа~~ /api/public/projects/{project_id}/branch/{branch_id}/snapshots/{snapshot_id}/fullmarkers ====		==== Метод /api/public/projects/{project_id}/branch/{branch_id}/snapshots/{snapshot_id}/fullmarkers ====

	~~Данная точка входа~~ служит для получения информации о маркерах указанного снимка. Информация о маркере может включать в себя:		Данный метод служит для получения информации о маркерах указанного снимка. Информация о маркере может включать в себя:

	* трассу ошибки (параметр traces, возможные значения true,false)		* трассу ошибки (параметр traces, возможные значения true,false)

Akuzmin: minor fixes

2025-11-26T10:27:36Z

minor fixes

Show changes

Chernykov sv: /* Примеры использования фильтров в public api */

2025-11-25T15:19:28Z

Примеры использования фильтров в public api

← Older revision		Revision as of 18:19, 25 November 2025
Line 56:		Line 56:
	Этот пример работает только с python3 и не работает при аутентификации в Svacer через LDAP.		Этот пример работает только с python3 и не работает при аутентификации в Svacer через LDAP.

	Скачайте и распакуйте [[~~index~~.php?title=Media:Get link.zip\|get_link.zip]]		Скачайте и распакуйте [[Index.php?title=Media:Get link.zip\|get_link.zip]]

	Запрос:		Запрос:
Line 65:		Line 65:

	=== Примеры использования фильтров в public api ===		=== Примеры использования фильтров в public api ===
	Данные фильтры служат только для ограничения вывода некоторых методов в public api. Они являются отдельной сущностью, наравне с глобальными фильтрами и пользовательскими фильтрами.		Данные фильтры служат только для ограничения вывода некоторых методов в public api. Они являются отдельной сущностью, наравне с глобальными фильтрами и пользовательскими фильтрами. Их основное отличие от последних двух в том, что время их жизни соответствует одному запросу, в котором они заданы.

	==== Вспомогательные модули ====		==== Вспомогательные модули ====

Chernykov sv: /* Вспомогательные модули */

2025-11-25T15:16:41Z

Вспомогательные модули

← Older revision		Revision as of 18:16, 25 November 2025
Line 9:		Line 9:
	* Простой способ — POST запрос с basic auth на '''/api/login''', который вернёт JWT-токен в body. Использование данного способа не желательно, так как он может меняться в будущем, а также не всегда правильно обрабатывает спец. символы и кириллицу в логине/пароле. Пример:		* Простой способ — POST запрос с basic auth на '''/api/login''', который вернёт JWT-токен в body. Использование данного способа не желательно, так как он может меняться в будущем, а также не всегда правильно обрабатывает спец. символы и кириллицу в логине/пароле. Пример:
	<pre>curl -X POST -u admin:admin http://svacer.example.com/api/login</pre>		<pre>curl -X POST -u admin:admin http://svacer.example.com/api/login</pre>
	* Предпочтительный способ — POST запрос на '''/api/public/login''' с передачей данных в теле запроса, как описано [[#public-api-login\|ниже]]. Пример:		* Предпочтительный способ — POST запрос на '''/api/public/login''' с передачей данных в теле запроса, как описано [[Help:Public API#public-api-login\|ниже]]. Пример:
	<pre>curl -X POST -d '{"login": "admin", "password": "admin"}' http://svacer.example.com/api/public/login</pre>		<pre>curl -X POST -d '{"login": "admin", "password": "admin"}' http://svacer.example.com/api/public/login</pre>

Line 56:		Line 56:
	Этот пример работает только с python3 и не работает при аутентификации в Svacer через LDAP.		Этот пример работает только с python3 и не работает при аутентификации в Svacer через LDAP.

	Скачайте и распакуйте [[Media:~~get_link~~.zip\|get_link.zip]]		Скачайте и распакуйте [[index.php?title=Media:Get link.zip\|get_link.zip]]

	Запрос:		Запрос:
Line 65:		Line 65:

	=== Примеры использования фильтров в public api ===		=== Примеры использования фильтров в public api ===
			Данные фильтры служат только для ограничения вывода некоторых методов в public api. Они являются отдельной сущностью, наравне с глобальными фильтрами и пользовательскими фильтрами.

	==== Вспомогательные модули ====		==== Вспомогательные модули ====

Chernykov sv: /* Примеры использования public REST API */

2025-11-25T15:14:16Z

Примеры использования public REST API

Show changes

Akuzmin: add markup2 link

2024-12-25T12:01:59Z

add markup2 link

← Older revision		Revision as of 15:01, 25 December 2024
Line 46:		Line 46:
	== Управление контейнерами ==		== Управление контейнерами ==
	См. [[Help:Public API/management/containers]]		См. [[Help:Public API/management/containers]]

			== Экспорт, импорт и копирование разметки ==
			См. [[Markup2]]

	== Примеры использования public REST API ==		== Примеры использования public REST API ==

Akuzmin: add public_api/management/containers page link

2024-11-27T14:16:52Z

add public_api/management/containers page link

← Older revision		Revision as of 17:16, 27 November 2024
Line 43:		Line 43:

	Также можете посмотреть на нашем демо-сервере: https://svacer-demo.ispras.ru/api/public/swagger/		Также можете посмотреть на нашем демо-сервере: https://svacer-demo.ispras.ru/api/public/swagger/

			== Управление контейнерами ==
			См. [[Help:Public API/management/containers]]

	== Примеры использования public REST API ==		== Примеры использования public REST API ==

Akuzmin: /* Получение URL загруженного снимка */

2024-01-22T15:55:50Z

Получение URL загруженного снимка

← Older revision		Revision as of 18:55, 22 January 2024
Line 48:		Line 48:
	=== Получение URL загруженного снимка ===		=== Получение URL загруженного снимка ===

	Скачайте и распакуйте [[Media:get_link.zip\|get_link.zip]]		Этот пример работает только с python3 и не работает при аутентификации в Svacer через LDAP.

			Скачайте и распакуйте [[Media:get_link.zip\|get_link.zip]]

	Запрос:		Запрос:

Akuzmin: fix swagger link

2023-11-27T10:56:25Z

fix swagger link

← Older revision		Revision as of 13:56, 27 November 2023
Line 40:		Line 40:
	\|}		\|}

	Описание остальных запросов смотрите в спецификации OpenAPI на вашем сервере Svacer по адресу <code>/api/public/swagger</code>		Описание остальных запросов смотрите в спецификации OpenAPI на вашем сервере Svacer по адресу <code>/api/public/swagger/</code>

	Также можете посмотреть на нашем демо-сервере: https://svacer-demo.ispras.ru/api/public/swagger		Также можете посмотреть на нашем демо-сервере: https://svacer-demo.ispras.ru/api/public/swagger/

	== Примеры использования public REST API ==		== Примеры использования public REST API ==