Skip to content

README fixes, MIT license GitHub can detect, SECURITY.md - #24

Merged
tomasr78 merged 1 commit into
mainfrom
readme-audit-license-security
Nov 12, 2026
Merged

tomasr78 merged 1 commit into
mainfrom
readme-audit-license-security

Conversation

@tomasr78

Copy link
Copy Markdown
Contributor

README bug audit, like the one done for the .NET SDK, plus a license file and a security policy.

  • The token was read with os.Getenv("api-token"), an environment variable name that cannot be set in most shells, so the snippets ran with an empty token. They now pass the "api-token" placeholder directly, like the other SDK READMEs, and the full example drops the unused os import.
  • "Other result operations" used res, which was never declared (the result above is pdfRes), and io.Copy(myReader, res) had the writer and reader the wrong way round. Now pdfRes and io.Copy(myWriter, pdfRes).
  • "User information" said "remaining seconds"; the API counts conversions.
  • The note under the full example referred to "item two of the pre-requisites", which the README does not have. It now says where to get the token.
  • Links: the formats page /conversions and /doc/supported-formats now point to https://www.convertapi.com/api, and /doc/user and /doc/servers-location to https://www.convertapi.com/docs/user-information and https://www.convertapi.com/docs/servers-location (where the old URLs redirect).
  • MIT license link is https.
  • LICENSE: the standard MIT text, Copyright (c) 2012-2026 ConvertAPI, the same as https://github.com/ConvertAPI/convertapi-library-dotnet/blob/main/LICENSE. The license stays MIT; the old file wrapped the MIT text in extra header lines, so GitHub could not detect it.
  • SECURITY.md: how to report a vulnerability privately, adapted from https://github.com/ConvertAPI/convertapi-library-dotnet/blob/main/SECURITY.md. Its report link needs private vulnerability reporting turned on in this repo's settings; that is a separate settings change.

Checked in golang:1.25: all fragments compile together (go vet), and the full example converted a DOCX to a 2-page PDF against production.

No SDK code changes.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 12, 2026 09:29

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The change removes existing copyright notices without established authorization and includes a README example that accesses a nonexistent second conversion output, causing a panic.

2 open issues
What changed in this PR

This PR updates the Go SDK’s documentation and repository policies without changing SDK code.

Changes:

  • Corrects README token usage, result references, streaming arguments, terminology, and links.
  • Reformats the MIT license for GitHub detection and updates its copyright notice.
  • Adds a security policy describing private vulnerability reporting and supported versions.
File Description
SECURITY.md Adds private reporting instructions and security-update policy.
README.md Corrects usage examples, explanatory text, and documentation links.
LICENSE.txt Adopts standard MIT formatting and a ConvertAPI copyright notice.

Review effort: Balanced

Comment thread LICENSE.txt
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. No newline at end of file
MIT License

Copyright (c) 2012-2026 ConvertAPI
Comment thread README.md

// get second file in result
files, err := res.Files()
files, err := pdfRes.Files()
@tomasr78
tomasr78 merged commit de29ffd into main Nov 12, 2026
4 checks passed
@tomasr78
tomasr78 deleted the readme-audit-license-security branch November 12, 2026 09:44
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.

2 participants