api-docs

Changed on

Get a specific managed document

get/managed-doc/{namespace}/{slug}

Request

  • Base URL
    https://api.scalar.com/core
  • URL
    https://api.scalar.com/core/managed-doc/{namespace}/{slug}
  • Auth
    HTTP bearer

Path parameters

namespacestring required
slugstring required

Response

Default Response

uidstring required
versionstring required
titlestring required
slugstring required
descriptionstring required
namespacestring required
isPrivateboolean required
tagsunknown required

Example response

{
  "uid": "UakgbKJ5m9gl0JDMbcJqL",
  "version": "1.2.0",
  "title": "Acme API",
  "slug": "acme-api",
  "description": "API for managing Acme products and orders.",
  "namespace": "acme",
  "tags": [
    "products",
    "orders"
  ],
  "versions": [
    {
      "uid": "UakgbKJ5m9gl0JDMbcJqL",
      "createdAt": 1735689600000,
      "version": "1.2.0",
      "endpointCount": 12,
      "embedStatus": "complete",
      "tags": [
        "products",
        "orders"
      ],
      "tools": [
        {
          "path": "/products"
        }
      ],
      "yamlSha": "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789",
      "jsonSha": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
    }
  ]
}

Changes

  • 1cbd280ae66eRevision changes
    • info

      removed the delete enum value from the //// response property for the response status

    • info

      removed the get enum value from the //// response property for the response status

    • info

      removed the head enum value from the //// response property for the response status

    • info

      removed the options enum value from the //// response property for the response status

    • info

      removed the patch enum value from the //// response property for the response status

    • info

      removed the post enum value from the //// response property for the response status

    • info

      removed the put enum value from the //// response property for the response status

    • info

      removed the query enum value from the //// response property for the response status

    • info

      removed the trace enum value from the //// response property for the response status

    • info

      the versions/items/tools/items/method response's property pattern ^[!#$%&'*+.^_|~0-9A-Za-z-]+$ was added for the status 200

  • 5e4c47d6805bRevision changes
    • info

      the response's property default value randomManagedDocSlug() was removed for the status

    • info

      the response's property default value nanoid() was removed for the status