2016-07-25 30 views
0

Ich habe eine API, dieWie schreibe ich Swagger Dokumentation für eine optionale Enum-Definition?

public Optional<Status> getStatus 

aber kann nicht herausfinden, wie die Prahlerei spec Definition aussehen sollte ähnlich sieht. Der swagger.io Editor Fehlermeldung für das folgende bedeutet nicht viel:

get: 
    ... 
    responses: 
    '200': 
     description: OK 
     schema: 
     $ref: '#/definitions/Status' 

definitions: 
    Status: 
    properties: 
     type: string 
     description: Blah 
     enum: 
     - UNKNOWN 

Antwort

0

war nur der äußere ‚Eigenschaften‘ Eigenschaft das Problem verursacht (als String nicht Objekt):

definitions: 
    Status: 
    type: string 
    description: Blah 
    enum: 
     - UNKNOWN