Sign in
Documentation

Proxy Documentation Request

Fetch and proxy documentation from external URLs to bypass CORS restrictions.

get/api/v1/documentation/proxy

Query parameters

urlstring uri required

Documentation URL to fetch (must be a valid HTTP/HTTPS URL)

Example:https://github.com/owner/repo/blob/main/README.md

Response

Successfully fetched and proxied documentation

contentstring required

The markdown/text content of the documentation

Example response

{
  "content": "# Documentation\n\nThis is the documentation content..."
}

Changes

Changed in 1 of the 11 revisions of this API.331

  • b0e6563d3fce331See the full diff
    • ▲

      the code response property const value INTERNAL_SERVER_ERROR was removed for the status 500

      response-property-const-removed

    • ▲

      the code response property const value NOT_FOUND was removed for the status 404

      response-property-const-removed

    • ▲

      the code response property const value TOO_MANY_REQUESTS was removed for the status 429

      response-property-const-removed

    • ●

      added the new INTERNAL_SERVER_ERROR enum value to the code response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new NOT_FOUND enum value to the code response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new TOO_MANY_REQUESTS enum value to the code response property for the response status 429

      response-property-enum-value-added

    • ○

      api operation id getApiV1DocumentationProxy removed and replaced with

      api-operation-id-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog