api-docs

Changed on

Get metadata for a specific api document version

get/managed-doc/{namespace}/{slug}/version/{semver}/metadata

Request

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

Path parameters

namespacestring required
slugstring required
semverstring required

Response

Default Response

uidstring required
createdAtnumber required
versionstring required
upgradedboolean required
endpointCountinteger nullable required
embedStatus'complete' | 'failed' nullable required
tagsstring[] required
yamlShastring
jsonShastring

Example response

{
  "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 tools/items/method response's property pattern ^[!#$%&'*+.^_|~0-9A-Za-z-]+$ was added for the status 200

  • 1c106ab43138Revision changes
    • warning

      added the new query enum value to the // response property for the response status