swagger-1c icon indicating copy to clipboard operation
swagger-1c copied to clipboard

Привести документацию оформления описания в корректный вид

Open Kyrales opened this issue 3 months ago • 4 comments

См. читабельный вариант оформления

image

Дополнительно шаблоны быстрого доступа добавить к примерам:

  1. Добавить свойство объекта (схема) .Свойство("<?>") .Описание("КраткоеОписание. В 1С: НазваниеОбъекта.ИмяРеквизита") .ТипЗначения("<?"Выберете тип свойства", ВыборВарианта, "string", "string", "integer", "integer", "boolean", "boolean", "number", "number">") .Пример("123")

  2. Добавить свойство объекта (схема) .Свойство("<?>") .Описание("") .ТипЗначения("<?"Выберете тип свойства", ВыборВарианта, "object", "object", "array", "array">") .Схема("ОбъектСсылкаПример") .Объект("ОбъектСсылкаПример") // дочерний объект свойства ИмяСвойства .Свойство("Идентификатор") .Описание("Идентификатор договора из 1С. В 1С: НазваниеОбъекта.ллл_КодРС") .ТипЗначения("string") .Пример("8f80d9d3-730a-4b8f-82a5-4ff52960691e")

Kyrales avatar Nov 30 '24 10:11 Kyrales