docs(sending-domains): add dkim_key_length to parent object schema and create response#578
Open
seewerah wants to merge 1 commit into
Open
docs(sending-domains): add dkim_key_length to parent object schema and create response#578seewerah wants to merge 1 commit into
seewerah wants to merge 1 commit into
Conversation
…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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
dkim_key_lengthfield to the Sending Domain Object'sdkimsub-object definition, matching what was already documented on the DKIM Keys sub-resource"dkim_key_length": 2048to the POST create response exampleCompanion to SparkPost/Momentum#1241, which exposes
dkim_key_lengthon the parent sending-domain create response and (in a follow-up) on GET/List responses.Test plan
dkim_key_lengthin the Sending Domain Object schema"dkim_key_length": 2048Note
Low Risk
Low risk docs-only change that updates the Sending Domains API schema/examples without affecting runtime behavior.
Overview
Adds
dkim_key_lengthto the Sending Domain object’sdkimsub-object schema to document the RSA key size derived from the current public key.Updates the
POST /v1/sending-domainssuccess response example to includedkim_key_lengthin the returneddkimpayload.Reviewed by Cursor Bugbot for commit 50e27af. Bugbot is set up for automated code reviews on this repo. Configure here.