Документация1С-Битрикс: Модулиnative.apiРазработчикамКонстанты

OpenAPI

use Native\Api\Config\Internals\OpenApiConfig;

$value = OpenApiConfig::OPENAPI;

Документ

КонстантаЗначение
OPENAPIopenapi
INFOinfo
TITLEtitle
VERSIONversion
TERMS_OF_SERVICEtermsOfService
CONTACTcontact
LICENSElicense
EMAILemail
URLurl
PATHSpaths
COMPONENTScomponents
SCHEMASschemas
SECURITY_SCHEMESsecuritySchemes
SCHEMEscheme

Операции

КонстантаЗначение
TAGStags
SUMMARYsummary
DESCRIPTIONdescription
EXTERNAL_DOCSexternalDocs
OPERATION_IDoperationId
PARAMETERSparameters
REQUEST_BODYrequestBody
RESPONSESresponses
CALLBACKScallbacks
DEPRECATEDdeprecated
SECURITYsecurity
SERVERSservers

Параметры и схемы

КонстантаЗначение
NAMEname
INin
REQUIREDrequired
SCHEMAschema
CONTENTcontent
TYPEtype
FORMATformat
PROPERTIESproperties
ITEMSitems
ENUMenum
MINIMUMminimum
MAXIMUMmaximum
MIN_ITEMSminItems
MAX_ITEMSmaxItems
NULLABLEnullable
ADDITIONAL_PROPERTIESadditionalProperties
ONE_OFoneOf
ALL_OFallOf
REF$ref
EXAMPLEexample
EXAMPLESexamples
VALUEvalue

Общие схемы ответа

КонстантаЗначение
SCHEMA_RESPONSE_TIMEResponseTime
SCHEMA_RESPONSE_STATUSResponseStatus
SCHEMA_RESPONSE_ERRORResponseError