Size: a a a

DocOps-сообщество

2021 December 06

MM

Mikhail Mironov in DocOps-сообщество
Здесь)
источник

CL

Constantine Linnick in DocOps-сообщество
без понятия, увидел в обновлении про md и запостил сюда
источник

CL

Constantine Linnick in DocOps-сообщество
скажу больше что rst в дикой природе не встречал
источник

ML

Maksim Lapshin in DocOps-сообщество
Вопрос:  мы документируем сейчас API в  OpenAPI и надо задокументировать евенты, которые могут вылетать из системы.

Их мы описали через oneOf

Хочется описать каждому варианту oneOf  свой description, но кажется, что openapi никак не поддерживает description у объекта.

Это так?  Если да, то как же описать варианты, куда этот текст положить?
источник

ML

Maksim Lapshin in DocOps-сообщество
выглядит, что другого способа, кроме как положить поле, указанное в discriminator, в каждую спеку и положить туда description, не видать
источник
2021 December 07

NP

Nikolaj Potashnikov in DocOps-сообщество
Возможно, нужен конкретный пример, чтобы понять проблему. У объекта то description как раз поддерживается. Сейчас специально вбил, и всё прекрасно... Другой вопрос, как oneOf кодогенерируется и документогенерируется... У нас, например, он запрещён к использованию, т.к. не поддерживается нашим генератором кода на Java
источник

ML

Maksim Lapshin in DocOps-сообщество
А где у обьекта может бытьdescription?

Я облазил спеку и не нашел. Зато помогло описать дискриминационное поле
источник

KV

Konstantin Valeev in DocOps-сообщество
Redoc, например, поддерживает: https://redoc.ly/docs/resources/discriminator/
источник

ML

Maksim Lapshin in DocOps-сообщество
Даа, мы его заюзали
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
ну вот, например, так не работает? У меня всё отлично... если не считать разработчиков
        category:
         description: abc
         oneOf:
           - $ref: '#/components/schemas/CategoryT1'
           - $ref: '#/components/schemas/CategoryT2'
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
документация поддерживает всё... а вот разработчики не всё
источник

ML

Maksim Lapshin in DocOps-сообщество
Я не про физическую возможность, а про валидность по спеке.

Разве в спеке есть?
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
скажем так, спеку в этой части не читал, но валидатор принимает на ура
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
а кто реджектит этот синтаксис?
источник

ML

Maksim Lapshin in DocOps-сообщество
Я перепроверю
источник