Include format with Secret types

[djlambert]

Feature Request

It'd be nice if SecretStr and SecretBytes included the format attribute with value password to hint UIs to mask the password.

    "secretKey": {
        "title": "Secret Key",
        "type": "string",
        "description": "Secret key",
        "writeOnly": true,
        "format": "password",
        "example": "your secret key"
    },

[samuelcolvin]

you mean in the schema?

[djlambert]

Yes, sorry should have specified.

[tiangolo]

@djlambert they have {"writeOnly": true}. That's what is recommended by the JSON Schema spec for passwords specifically: http://json-schema.org/latest/json-schema-validation.html#rfc.section.10.3

There's no official format of "password" in the specs.

And the writeOnly is supposed to convey the equivalent message. So, I think having an additional, custom password format could misguide developers.

[djlambert]

It wouldn't be custom, it's in the OpenAPI specs https://swagger.io/specification/#dataTypes

[tiangolo]

You're right @djlambert.

It's not in JSON Schema but it's indeed in OpenAPI.

I think that deserves a PR.

[Atheuz]

Here's a PR: #1424

[Atheuz]

This can be closed due to fix merged in PR #1424