validator - Swagger Editor muestra el error "Error de esquema: NO debe tener propiedades adicionales" para un parĂ¡metro de ruta
swagger validator (2)
Estoy usando http://editor.swagger.io para diseñar una API y recibo un error que no sé cómo abordar:
Schema error at paths[''/employees/{employeeId}/roles''].get.parameters[0]
should NOT have additional properties
additionalProperty: type, format, name, in, description
Jump to line 24
Tengo otros puntos finales definidos de manera similar, y no recibo este error. Me pregunté si tenía algún problema con la sangría o las citas sin cerrar, pero ese no parece ser el caso. Google tampoco pareció proporcionar ningún resultado útil.
swagger: "2.0"
info:
description: Initial draft of the API specification
version: ''1.0''
title: App 4.0 API
host: api.com
basePath: /v1
tags:
- name: employees
description: Employee management
schemes:
- https
paths:
/employees/{employeeId}/roles:
get:
tags:
- employees
summary: "Get a specific employee''s roles"
description: ''''
operationId: findEmployeeRoles
produces:
- application/json
parameters:
- name: employeeId <====== Line 24
in: path
description: Id of employee whose roles we are fetching
type: integer
format: int64
responses:
''200'':
description: successful operation
schema:
type: array
items:
$ref: ''#/definitions/Role''
''403'':
description: No permission to see employee roles
''404'':
description: EmployeeId not found
¿Alguna pista?
El mensaje de error es engañoso. El error real es que falta el parámetro de ruta required: true
. Los parámetros de la ruta son siempre necesarios, así que recuerde agregar los required: true
a ellos.
La sintaxis requerida puede requerir dos parámetros, como lo mencionó Helen required: true
es necesaria, así es el type:DataType
El error es engañoso.