Как пометить службу REST как устаревшую в RAML

Мы обновляем нашу спецификацию RAML 0.8 и хотим пометить метод как устаревший и указать на другой метод в том же API. Возможно ли это в RAML? Я читал некоторые статьи, но пока не ясно, реализовано ли это


raml
person Stanislav Ivanov    schedule 21.06.2016    source источник

Ответы (1)


arrow_upward
5
arrow_downward

В RAML 0.8 эта концепция отсутствует. RAML 1.0 добавил аннотации в глобальный раздел для передачи таких метаданных.

P.S.: Образец аннотации об устаревании

deprecated:
  properties:
    replaceWith:
      type: string
      description: |
        Describe the alternative resource/method that can be used as a substitute.
      required: true
    since:
      type: string
      pattern: (0[1-9]|10|11|12)/20[0-9]{2}
      required: true
      description: Describe when the resource/method became deprecated in the format (mm/YYYY)
  allowedTargets: [Resource, Method]
  displayName: Deprecated
  description: |
    A deprecated resource or method is *not* recommended for new work.
    The resource or method will be removed in a future version of the API.

    Deprecation does NOT mean it is not supported anymore in the current version.
person Kaj Kandler    schedule 24.06.2016
comment
Спасибо за ваш ответ! Я проверил это дальше, и это именно так, как вы сказали. - person Stanislav Ivanov; 26.06.2016