халп
простой (ХЗ, на самом деле не очень) вопрос. Стоит ли держать спеку (напр. OAS) в отдельной от эндпоинтов, которые она описывает, репе?
Ну тип если рассмотреть монорепо-проект - часто всю спеку полностью кладут в отдельную папку. У нас проблема в том, что хотят запихнуть спеку по всем эндпоинтам (которые в разных репах) в одну общую репу документации.
Мне кажется, что с точки зрения кохижена и каплинга лучше всего пихать спеку к тому модулю, который спека описывает, это упростит изменения(не надо делать коммит в 2 репозитория по 1 фиче), удобнее будет подключать валидацию по json-schema.
Кто как делает?
Давай начнём с простого: зачем нужна спека? То есть как вы планируете её использовать? Если "вручную" - то вполне можно держать в том же репо. Если вы используете contract-based testing, то эта спека тоже ещё не весь контракт, видимо, и её тоже можно держать в том же репо. Это удобно ещё и тем, что на этапе ревью пулреквеста можно посмотреть, как собственно изменилась спека, и даже, возможно, посмотреть автомагически на schema evolution и совместимость. И это в принципе не зависит от того, отталкиваетесь от спеки или генерите её из кода.