Skip to content

Format descriptions in schema docs are imprecise #179

@davidben

Description

@davidben

The schema docs stay things like:

Pem encoded public key
Pem encoded private key

The format is called PEM, not Pem. I guess the types do the camel-case thing on the initialisms, but docs for human consumption should use the more conventional "PEM" spelling.

DER encoded public key

This doesn't say the format. It should specify whether this is a SubjectPublicKeyInfo or RSAPublicKey or whatever. Sampling things, it seems SubejctPublicKeyInfo is the most common, but I haven't checked all of them.

Pkcs 8 encoded private key

I mean, this is actually specific, but in human docs, it should be styled "PKCS #8". (If we're touching it, I might say "PKCS #8 PrivateKeyInfo" since PKCS #8 is the document.)

But I also agree with #178 (comment) that maybe we shouldn't have so many formats.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions