Как назвать свойство, используя зарезервированное ключевое слово в OpenApi / Swagger / YAML - PullRequest
0 голосов
/ 27 февраля 2019

Есть ли способ назвать пользовательское свойство type, учитывая, что уже существует специальное свойство type, которое является зарезервированным ключевым словом.

components:  
  schemas:  
  element:  
  type: object 
  properties:  
    name:  
      type: string  #type here is the keyword
    type: #type here is the actual name of the property!
      type: string
        enum:
          - radiogroup
          - checkbox

Внутренняя система, которая создаетСообщения JSON нельзя изменить, чтобы переименовать свойство.Спасибо.

1 Ответ

0 голосов
/ 27 февраля 2019

Зарезервированные ключевые слова могут использоваться в качестве имен свойств / параметров в OpenAPI.

Единственная проблема в вашем примере заключается в том, что отступ YAML отключен, за исключением того, что определения вашего объекта и свойства полностью действительны.

components:  
  schemas:  
    element:  
      type: object 
      properties:  
        name:  
          type: string
        type:   # <----- yes, property name can be "type"
          type: string
          enum:
            - radiogroup
            - checkbox
...