Skip to content
HALOWERK

Codewerk

codeowners check

Parses a CODEOWNERS file (inline, or found in .github/, root, docs/ of a public repository or git bundle, in GitHub's search order) and matches every rule against every file with GitHub's documented semantics: gitignore-style patterns, last matching rule wins, case-sensitive, docs/* only direct children, no negation, no character ranges, inline comments. Reports the owners of every file, files without owner, rules that match nothing, rules always overridden by later rules, lines GitHub would.

POST https://code.halowerk.com/v1/codeowners-check

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
codeownersstringNoCODEOWNERS content. With repo_url/bundle_base64 it overrides the file found in the repository.
filesarrayNoRepository-relative file paths (e.g. git ls-files) when no repository is given.
repo_urlstringNoPublic HTTPS clone URL, e.g. https://github.com/owner/repo. No credentials, port 443 only; ssh/git/file URLs are rejected.
bundle_base64stringNoAlternative to repo_url: a git bundle (git bundle create repo.bundle --all), base64-encoded, up to about 180 KB.
refstringNoBranch or tag to analyse instead of the default branch.
max_listintegerNoMaximum number of paths listed per category.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "codeowners": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200000,
      "description": "CODEOWNERS content. With repo_url/bundle_base64 it overrides the file found in the repository."
    },
    "files": {
      "type": "array",
      "minItems": 1,
      "maxItems": 20000,
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 500
      },
      "description": "Repository-relative file paths (e.g. git ls-files) when no repository is given."
    },
    "repo_url": {
      "type": "string",
      "minLength": 12,
      "maxLength": 300,
      "pattern": "^https://\\S+$",
      "description": "Public HTTPS clone URL, e.g. https://github.com/owner/repo. No credentials, port 443 only; ssh/git/file URLs are rejected."
    },
    "bundle_base64": {
      "type": "string",
      "minLength": 24,
      "maxLength": 250000,
      "description": "Alternative to repo_url: a git bundle (git bundle create repo.bundle --all), base64-encoded, up to about 180 KB."
    },
    "ref": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9._/-]*$",
      "description": "Branch or tag to analyse instead of the default branch."
    },
    "max_list": {
      "type": "integer",
      "minimum": 1,
      "maximum": 2000,
      "default": 200,
      "description": "Maximum number of paths listed per category."
    }
  }
}

Open original schema

Published input example

{
  "codeowners": "* @acme/core\n*.js @acme/frontend\n/docs/ @acme/docs\n",
  "files": [
    "README.md",
    "src/app.js",
    "docs/index.md"
  ]
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’