Rename bouncers to Remediation component in openAPI (#2936)

* Rename bouncers to Remediation component in openAPI
This commit is contained in:
AlteredCoder 2024-04-11 11:23:19 +02:00 committed by GitHub
parent 2291a232cb
commit 0746e0c091
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -26,10 +26,10 @@ produces:
paths: paths:
/decisions/stream: /decisions/stream:
get: get:
description: Returns a list of new/expired decisions. Intended for bouncers that need to "stream" decisions description: Returns a list of new/expired decisions. Intended for remediation component that need to "stream" decisions
summary: getDecisionsStream summary: getDecisionsStream
tags: tags:
- bouncers - Remediation component
operationId: getDecisionsStream operationId: getDecisionsStream
deprecated: false deprecated: false
produces: produces:
@ -39,7 +39,7 @@ paths:
in: query in: query
required: false required: false
type: boolean type: boolean
description: 'If true, means that the bouncers is starting and a full list must be provided' description: 'If true, means that the remediation component is starting and a full list must be provided'
- name: scopes - name: scopes
in: query in: query
required: false required: false
@ -73,10 +73,10 @@ paths:
security: security:
- APIKeyAuthorizer: [] - APIKeyAuthorizer: []
head: head:
description: Returns a list of new/expired decisions. Intended for bouncers that need to "stream" decisions description: Returns a list of new/expired decisions. Intended for remediation component that need to "stream" decisions
summary: GetDecisionsStream summary: GetDecisionsStream
tags: tags:
- bouncers - Remediation component
operationId: headDecisionsStream operationId: headDecisionsStream
deprecated: false deprecated: false
produces: produces:
@ -100,7 +100,7 @@ paths:
description: Returns information about existing decisions description: Returns information about existing decisions
summary: getDecisions summary: getDecisions
tags: tags:
- bouncers - Remediation component
operationId: getDecisions operationId: getDecisions
deprecated: false deprecated: false
produces: produces:
@ -164,7 +164,7 @@ paths:
description: Returns information about existing decisions description: Returns information about existing decisions
summary: GetDecisions summary: GetDecisions
tags: tags:
- bouncers - Remediation component
operationId: headDecisions operationId: headDecisions
deprecated: false deprecated: false
produces: produces:
@ -1008,7 +1008,7 @@ definitions:
title: "error response" title: "error response"
description: "error response return by the API" description: "error response return by the API"
tags: tags:
- name: bouncers - name: Remediation component
description: 'Operations about decisions : bans, captcha, rate-limit etc.' description: 'Operations about decisions : bans, captcha, rate-limit etc.'
- name: watchers - name: watchers
description: 'Operations about watchers : cscli & crowdsec' description: 'Operations about watchers : cscli & crowdsec'