fix(docs): update OpenAPI spec link to point to GitHub#721
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Updates the SDK documentation to reference the canonical OpenAPI specification on GitHub, aligning the docs with the repo’s source of truth.
Changes:
- Update the OpenAPI spec link from a relative path to a GitHub URL.
- Minor formatting adjustment in the TypeScript usage example (
console.logcall formatting).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Outpost provides Software Development Kits (SDKs) to help you integrate your applications with the Outpost API seamlessly. These SDKs are designed to simplify the process of publishing events and managing your Outpost resources. | ||
|
|
||
| The SDKs are generated from the <a href="./apis/openapi.yaml">Outpost OpenAPI specification</a> using [Speakeasy](https://speakeasy.com). | ||
| The SDKs are generated from the <a href="https://github.com/hookdeck/outpost/blob/main/docs/apis/openapi.yaml" target="_blank">Outpost OpenAPI specification</a> using [Speakeasy](https://speakeasy.com). |
There was a problem hiding this comment.
The target="_blank" on this external link is missing a rel="noopener noreferrer" attribute, which allows the opened page to access window.opener and potentially redirect the original docs tab (reverse tabnabbing/phishing). An attacker controlling the external site could use this to impersonate your docs or app in the original tab and steal credentials. Add the appropriate rel attributes to this anchor to prevent the new page from gaining a reference to the opener window.
| The SDKs are generated from the <a href="https://github.com/hookdeck/outpost/blob/main/docs/apis/openapi.yaml" target="_blank">Outpost OpenAPI specification</a> using [Speakeasy](https://speakeasy.com). | |
| The SDKs are generated from the <a href="https://github.com/hookdeck/outpost/blob/main/docs/apis/openapi.yaml" target="_blank" rel="noopener noreferrer">Outpost OpenAPI specification</a> using [Speakeasy](https://speakeasy.com). |
No description provided.