doc: updated tls docs for tls socket subjectaltname #27734
Conversation
The documentation for tlsSocket.getPeerCertificate() stated that the certificate object returned subjectaltname as an array however it actually returned a concatenated list of strings as a single string docs have been updated to reflect this Fixes: #27721
nodejs-github-bot
added
doc
doc/api/tls.md
Outdated
| @@ -917,7 +917,7 @@ certificate. | |||
| It is returned as a `:` separated hexadecimal string. Example: | |||
| `'2A:7A:C2:DD:...'`. | |||
| * `ext_key_usage` {Array} (Optional) The extended key usage, a set of OIDs. | |||
| * `subjectaltname` {Array} (Optional) An array of names for the subject, an | |||
| * `subjectaltname` {string} (Optional) A string containing concatenated names for the subject, an | |||
There was a problem hiding this comment.
I think the linter is not happy with this long line.
|
Original Commit message was invalid, closing and resubmitting as I cant go back and fix that. |
|
Anything about this PR, including the commit message, can be rewritten, it is not necessary to open a new PR. Can you reopen this, to preserve conversation and approvals, and then describe what needs to be fixed? I can either explain how, if you would like to, or I can force push to your branch to fix it for you. |
|
I didnt think of that, completely agree about keeping this PR. I deleted my remote fork of node.js - ive still got the local version, however reforking and pushing my local changes to the new remote fork isnt letting me open this PR? What would you suggest as steps forward. First time contributing to a Open Source project so still learning the ropes. |
|
If you deleted the fork, then yes, you may have to re-PR the change. I can't see the option, but since you made this PR, if you look up through the history, you may see a button somewhere on this page that says something about "undeleting" the branch. If so, try that, if not, you'll have to push your local branch to your new fork. |
|
Recreated in #27757 since Fork was deleted, pushed local copy to new branch. |
The documentation for tlsSocket.getPeerCertificate() stated that the
certificate object returned subjectaltname as an array
however it actually returned a concatenated list of strings as a single string
docs have been updated to reflect this
Fixes: #27721
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes