Implement additional format: byte

[wing328]

Currently, byte (format) is treated as "string" and there's a TODO in StringProperty to implement additional formats.

swagger-core/modules/swagger-models/src/main/java/com/wordnik/swagger/models/properties/StringProperty.java

Line 88 in ee0b639

//TODO: implement additional formats

If no concern from anyone, I'll update the code to support byte as a property.

[webron]

@wing328 - not really sure what's missing.. byte is treated as a valid format there.

[wing328]

@webron If you look at the folder containing the StringProperty.java, it has "DateTimeProperty.java" but no "ByteProperty.java" (both have type set to string)

swagger-core/modules/swagger-models/src/main/java/com/wordnik/swagger/models/properties/StringProperty.java

Line 90 in ee0b639

if("string".equals(type) && (format == null || "uri".equals(format) || "byte".equals(format)))

The above line checks type and format to determine if a property is a string. I think the TODO refers to implementing byte as a property itself (instead of treating byte as string)

In swagger-codegen, a response (type: string, format: byte) will always map to string. Ideally one can map it manually to something else (e.g. byte[]) using typeMapping.

[webron]

Fair enough. However, as mentioned in one of the codegen comments, byte format is intended to be a Base64 encoded string, hence the string type. I'm not sure that would solve the issue that led you here.

[wing328]

I would recommend updating the comment section on Swagger Spec 2.0 Data Types to mention about Base64-encoded string for byte

[webron]

@wing328 - can you open an issue about it on swagger-spec? I want to make sure that this was indeed the intent.

[wing328]

@webron shall we resume the conversation in OAI/OpenAPI-Specification#50 to confirm ?

[webron]

@wing328 - sure. That issue was originally opened for 1.2, but it applies to 2.0 just as well.

[fehguy]

I'm closing this out as it's a spec issue, and has a corresponding issue in that repo.

[wing328]

Totally agree.