Raiffeisenbank (Russia) · API Governance Rules
Raiffeisenbank (Russia) API Rules
Spectral linting rules defining API design standards and conventions for Raiffeisenbank (Russia).
60 Rules
error 49
warn 7
info 4
Published by Raiffeisenbank (Russia)
Served by the provider at https://github.com/Raiffeisen-DGTL/rest-api-guide/blob/b2afc8e0247d5ff43a3cb61b2c343752fd2f6ee6/spectral/base-ruleset.yaml; the copy below was fetched from there.
Rule Categories
all
array
blank
body
contact
description
duplicated
empty
enum
info
method
names
no
not
oas3
oas3_1
object
openapi
operation
path
provide
query
response
supported
tag
typed
url
use
valid
Rules
error
all-off-types-consistency
Все элементы allOf должны иметь одинаковый тип
$..[?(@ && @.allOf)]
error
array-items
Объекты типа Array должны содержать массив элементов
#ArrayProperties
error
blank-strings-forbidden
Пустые строки запрещены
$..[description,title]$..[required[*]]$..[summary,example]$..[x-raif-api-description-en]
error
body-fields-camel-case
Поля в requestBody и responseBody должны быть в camelCase
$.paths.*.*.requestBody.content.*.schema..properties.*~$.paths.*.requestBody.content.*.schema..properties.*~$.paths.*.*.responses.*.content.*.schema..properties.*~$.paths.*.responses.*.content.*.schema..properties.*~$.components.schemas.*..properties.*~$.components.requestBodies.*.content.*.schema..properties.*~$.components.responses.*.content.*.schema..properties.*~
error
contact-x-team-id-required
Поле info.contact.x-team-id является обязательным
$.info
error
description-required-for-schema-fields
У каждого поля в схеме должен быть description
$..properties.*$.components.schemas.*.enum[*]
error
duplicated-entry-in-enum
Значения в ENUM должны быть уникальны.
$..enum
error
empty-objects-forbidden
Запрещены пустые объекты
$$..*
error
enum-discriminator-upper-snake-case
Перечисления и значения маппинга для дискриминаторов именуются UPPER_SNAKE_CASE
$.components.schemas..enum[*]$.components.schemas..discriminator.mapping.*~
error
info-contact
Блок info должен содержать раздел contact
$
error
info-description
Блок info должен содержать раздел description
$
error
method-operation-id-camel-case
OperationId должны быть в camelCase формате
$.paths[*][get,put,post,delete,options,head,patch,trace]
error
method-request-response-components
Тело запроса и ответа должны быть вынесены в блок components как schema
$.paths
error
names-should-be-in-english
Названия полей, параметров и операций должны быть на английском языке
$..enum[*]$.paths[*][get,put,post,delete,options,head,patch,trace].operationId$.paths[*][get,put,post,delete,options,head,patch,trace].parameters[*].name$.components.parameters[*].name$.components.schemas.*~$.components.schemas.*.properties.*~$.paths[*][get,put,post,delete,options,head,patch,trace].requestBody.content.*.schema.properties.*~$.paths[*][get,put,post,delete,options,head,patch,trace].responses.*.content.*.schema.properties.*~
error
no-eval-in-markdown
Блок description и title не должен содержать eval()
$..[description,title]
error
no-ref-siblings
Рядом с $ref не должно быть property
$.paths
error
no-script-tags-in-markdown
Блок description и title не должен содержать
Work with this as data
Every ruleset here is available over the APIs.io API and to AI agents over MCP.