← Back
Editing: composer-repository-schema.json
{ "$schema": "https://json-schema.org/draft-04/schema#", "title": "Composer Package Repository", "type": "object", "oneOf": [ { "required": [ "packages" ] }, { "required": [ "providers" ] }, { "required": [ "provider-includes", "providers-url" ] }, { "required": [ "metadata-url" ] } ], "properties": { "packages": { "type": ["object", "array"], "description": "A hashmap of package names in the form of <vendor>/<name>.", "additionalProperties": { "$ref": "#/definitions/versions" } }, "metadata-url": { "type": "string", "description": "Endpoint to retrieve package metadata data from, in Composer v2 format, e.g. '/p2/%package%.json'." }, "available-packages": { "type": "array", "items": { "type": "string" }, "description": "If your repository only has a small number of packages, and you want to avoid serving many 404s, specify all the package names that your repository contains here." }, "available-package-patterns": { "type": "array", "items": { "type": "string" }, "description": "If your repository only has a small number of packages, and you want to avoid serving many 404s, specify package name patterns containing wildcards (*) that your repository contains here." }, "security-advisories": { "type": "array", "items": { "type": "object", "required": ["metadata", "api-url"], "properties": { "metadata": { "type": "boolean", "description": "Whether metadata files contain security advisory data or whether it should always be queried using the API URL." }, "api-url": { "type": "string", "description": "Endpoint to call to retrieve security advisories data." } } } }, "filter": { "type": "object", "description": "Filter list configuration advertised by the repository.", "required": ["metadata", "lists"], "properties": { "metadata": { "type": "boolean", "description": "Whether metadata files contain filter list data." }, "lists": { "type": "object", "description": "Names of all filter lists provided by this repository, mapped to an object describing the list. The object shape allows future per-list metadata to be added without another wire-format break.", "additionalProperties": { "type": "object", "required": ["enabled"], "properties": { "enabled": { "type": "boolean", "description": "Indicates if the filter list is available." } } } }, "summary-url": { "type": "string", "description": "Endpoint returning a compact mapping of list name to package name to version constraint, used to skip per-package metadata fetches for packages that cannot match any active list." }, "api-url": { "type": "string", "description": "Endpoint that accepts a POST body with the relevant package PURLs and configured list names and returns the matching filter entries directly. Takes precedence over summary-url when both are advertised." } } }, "metadata-changes-url": { "type": "string", "description": "Endpoint to retrieve package metadata updates from. This should receive a timestamp since last call to be able to return new changes. e.g. '/metadata/changes.json'." }, "providers-api": { "type": "string", "description": "Endpoint to retrieve package names providing a given name from, e.g. '/providers/%package%.json'." }, "notify-batch": { "type": "string", "description": "Endpoint to call after multiple packages have been installed, e.g. '/downloads/'." }, "search": { "type": "string", "description": "Endpoint that provides search capabilities, e.g. '/search.json?q=%query%&type=%type%'." }, "list": { "type": "string", "description": "Endpoint that provides a full list of packages present in the repository. It should accept an optional `?filter=xx` query param, which can contain `*` as wildcards matching any substring. e.g. '/list.json'." }, "warnings": { "type": "array", "items": { "type": "object", "required": ["message", "versions"], "properties": { "message": { "type": "string", "description": "A message that will be output by Composer as a warning when this source is consulted." }, "versions": { "type": "string", "description": "A version constraint to limit to which Composer versions the warning should be shown." } } } }, "infos": { "type": "array", "items": { "type": "object", "required": ["message", "versions"], "properties": { "message": { "type": "string", "description": "A message that will be output by Composer as info when this source is consulted." }, "versions": { "type": "string", "description": "A version constraint to limit to which Composer versions the info should be shown." } } } }, "providers-url": { "type": "string", "description": "DEPRECATED: Endpoint to retrieve provider data from, e.g. '/p/%package%$%hash%.json'." }, "provider-includes": { "type": "object", "description": "DEPRECATED: A hashmap of provider listings.", "additionalProperties": { "$ref": "#/definitions/provider" } }, "providers": { "type": "object", "description": "DEPRECATED: A hashmap of package names in the form of <vendor>/<name>.", "additionalProperties": { "$ref": "#/definitions/provider" } }, "warning": { "type": "string", "description": "DEPRECATED: A message that will be output by Composer as a warning when this source is consulted." }, "warning-versions": { "type": "string", "description": "DEPRECATED: A version constraint to limit to which Composer versions the warning should be shown." }, "info": { "type": "string", "description": "DEPRECATED: A message that will be output by Composer as a info when this source is consulted." }, "info-versions": { "type": "string", "description": "DEPRECATED: A version constraint to limit to which Composer versions the info should be shown." } }, "definitions": { "versions": { "type": "object", "description": "A hashmap of versions and their metadata.", "additionalProperties": { "$ref": "#/definitions/version" } }, "version": { "type": "object", "oneOf": [ { "$ref": "#/definitions/package" }, { "$ref": "#/definitions/metapackage" } ] }, "package-base": { "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "version_normalized": { "type": "string", "description": "Normalized version, optional but can save computational time on client side." }, "autoload": { "type": "object" }, "require": { "type": "object" }, "replace": { "type": "object" }, "conflict": { "type": "object" }, "provide": { "type": "object" }, "time": { "type": "string" } }, "additionalProperties": true }, "package": { "allOf": [ { "$ref": "#/definitions/package-base" }, { "properties": { "dist": { "type": "object" }, "source": { "type": "object" } } }, { "oneOf": [ { "required": [ "name", "version", "source" ] }, { "required": [ "name", "version", "dist" ] } ] } ] }, "metapackage": { "allOf": [ { "$ref": "#/definitions/package-base" }, { "properties": { "type": { "type": "string", "enum": [ "metapackage" ] } }, "required": [ "name", "version", "type" ] } ] }, "provider": { "type": "object", "properties": { "sha256": { "type": "string", "description": "Hash value that can be used to validate the resource." } } } } }
Save File
Cancel