Поддерживает ли спецификация Open API 3.0 журналы изменений?

Я использую спецификацию Open API 3.0 для документирования своих API.

Я заметил, что Open API 3.0 имеет атрибут version. Мне было интересно, есть ли у него способ документировать журналы изменений. Или просто использовать атрибут externalDocs?


openapi
person beckn    schedule 14.08.2020    source источник

Ответы (1)


arrow_upward
1
arrow_downward

Журналы изменений не являются встроенной функцией спецификации, но поле версии определенно помогает в качестве основы для их создания. У меня есть действие GitHub, которое выполняет выпуск на GitHub при изменении номера версии спецификации (что происходит при каждом изменении, которое мы вносим), поэтому страница выпусков становится нашим журналом изменений. Данные также можно взять из релизов (доступно через GitHub API).

Что касается указания на журнал изменений - вероятно, externalDocs - хороший способ сделать это.

person Lorna Mitchell    schedule 27.08.2020