dredd erwartet Beispiel Parameter in Prahlerei json

Question

machte ich meine erste Prahlerei api spec und dredd gab Fehler:

error: Compilation error in file '../../docs/swagger.json': Required URI parameter 'id_person' has no example or default value. (person > /person/{id_person} > Updates a already existing person ID with form data)

Also gab ich einen Standardwert auf den Parameter und jetzt immer von dredd Warnung:

Required URI parameter 'id_person' has a default value. Default value for a required parameter doesn't make sense from API description perspective. Use example value instead.

ich mag Beispiel IDs in der Spezifikation geben, aber ich kann nicht, wie man in der Swagger Spezifikation finden.

Mein Snip meiner Prahlerei:

"post": { 
       "tags": ["person"], 
       "summary": "Updates a already existing person ID with form data", 
       "operationId": "createNewPerson", 
       "consumes": ["application/x-www-form-urlencoded"], 
       "produces": ["application/json", "application/xml"], 
       "parameters": [ 
        { 
         "name": "id_person", 
         "in": "path", 
         "description": "ID of person to update", 
         "required": true, 
         "type": "integer", 
         "format": "int64", 
         "default": 1 
        }, 

Answer 1

Nach https://dredd.readthedocs.io/en/latest/how-to-guides/#example-values-for-request-parameters Dredd unterstützt die x-example Erweiterung Eigenschaft der Parameter Beispiele angeben:

   "parameters": [ 
        { 
         "name": "id_person", 
         "in": "path", 
         "description": "ID of person to update", 
         "required": true, 
         "type": "integer", 
         "format": "int64", 
         "x-example": 1 
        },