forked from astrizhachuk/epf-transmitter
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api-gitlab-services.yaml
166 lines (166 loc) · 4.95 KB
/
api-gitlab-services.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
openapi: 3.0.1
servers:
# Added by API Auto Mocking Plugin
- description: Develop
url: http://localhost/api/hs/gitlab
- description: SwaggerHub API Auto Mocking
url: https://virtserver.swaggerhub.com/astrizhachuk/gitlab-services/1.0.0
info:
title: API взаимодействия с GitLab
description: |
Работа с сервисами GitLab
contact:
email: [email protected]
version: 1.0.0
tags:
- name: default
description: Общие методы
- name: webhooks
description: Обработка вебхук
paths:
/services:
get:
tags:
- default
summary: Описание сервисов
description: |
Описание текущего состояния настроек HTTP-сервисов
взаимодействия с GitLab и описание их метаданных в системе 1С
operationId: services
responses:
200:
description: Описание сервисов
content:
application/json:
schema:
$ref: '#/components/schemas/services'
/webhooks/epf/push:
post:
tags:
- webhooks
summary: Обработка события "push events"
description: |
Обработка события "push events" вебхука GitLab
operationId: webhooksEpfPush
parameters:
- name: X-Gitlab-Event
in: header
description: X-Gitlab-Event
required: true
schema:
type: string
enum:
- Push Hook
responses:
200:
description: Успех
content:
application/json:
schema:
$ref: '#/components/schemas/response'
example:
type: "info"
message: "Запрос обработан."
400:
description: Ошибочный запрос
403:
description: Доступ закрыт
content:
application/json:
schema:
$ref: '#/components/schemas/response'
example:
type: "warning"
message: "Секретный токен не найден."
423:
description: Функционал отключен
content:
application/json:
schema:
$ref: '#/components/schemas/response'
example:
type: "warning"
message: "Отключен функционал загрузки из внешнего хранилища."
security:
- api_key: []
components:
schemas:
response:
type: object
properties:
type:
type: string
enum:
- info
- warning
- error
message:
type: string
services:
type: object
description: "Описание сервисов из метаданных"
properties:
version:
type: string
description: "Версия конфигурации"
services:
$ref: "#/components/schemas/gitlab"
gitlab:
type: object
description: "Описание сервиса из метаданных"
properties:
name:
type: string
description: "Имя сервиса"
desc:
type: string
description: "Описание сервиса (из комментария)"
enabled:
type: boolean
description: "Текущее состояние"
templates:
$ref: "#/components/schemas/templates"
templates:
type: array
description: "Описание шаблонов из метаданных"
items:
$ref: "#/components/schemas/template"
template:
type: object
description: "Описание шаблона из метаданных"
properties:
name:
type: string
description: "Имя шаблона"
desc:
type: string
description: "Описание шаблона (из комментария)"
template:
type: string
description: "Шаблон"
methods:
type: array
description: "Описание методов из метаданных"
items:
$ref: "#/components/schemas/method"
method:
type: object
description: "Описание метода из метаданных"
properties:
name:
type: string
description: "Имя метода"
desc:
type: string
description: "Описание метода (из комментария)"
method:
type: string
description: "Метод"
enum:
- GET
- POST
securitySchemes:
api_key:
type: apiKey
name: X-Gitlab-Token
in: header