Skip to content

docs(sending-domains): add dkim_key_length to parent object schema and create response#578

Open
seewerah wants to merge 1 commit into
mainfrom
feat/dkim-key-length-on-parent-object
Open

docs(sending-domains): add dkim_key_length to parent object schema and create response#578
seewerah wants to merge 1 commit into
mainfrom
feat/dkim-key-length-on-parent-object

Conversation

@seewerah
Copy link
Copy Markdown
Contributor

@seewerah seewerah commented May 21, 2026

Summary

  • Add the dkim_key_length field to the Sending Domain Object's dkim sub-object definition, matching what was already documented on the DKIM Keys sub-resource
  • Add "dkim_key_length": 2048 to the POST create response example

Companion to SparkPost/Momentum#1241, which exposes dkim_key_length on the parent sending-domain create response and (in a follow-up) on GET/List responses.

Test plan

  • Verify the rendered docs show dkim_key_length in the Sending Domain Object schema
  • Verify the POST create response example includes "dkim_key_length": 2048

Note

Low Risk
Low risk docs-only change that updates the Sending Domains API schema/examples without affecting runtime behavior.

Overview
Adds dkim_key_length to the Sending Domain object’s dkim sub-object schema to document the RSA key size derived from the current public key.

Updates the POST /v1/sending-domains success response example to include dkim_key_length in the returned dkim payload.

Reviewed by Cursor Bugbot for commit 50e27af. Bugbot is set up for automated code reviews on this repo. Configure here.

…e response (SparkPost/Momentum#1241)

Add the dkim_key_length field to the Sending Domain Object's dkim
sub-object definition and to the POST create response example. The
field was already documented on the DKIM Keys sub-resource but was
missing from the parent sending-domain schema and its create response
example.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant