vbatts/registry
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

documentation for name validation grammar

Browse source 
Signed-off-by: Stephen J Day <stephen.day@docker.com>
This commit is contained in:
Stephen J Day 2015-02-26 16:06:36 -08:00
parent 00ce453315
commit ac7af800fb
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/api/v2/names.go
View file

@ -82,6 +82,16 @@ var (
// registry. This function accepts a superset of what might be accepted by // registry. This function accepts a superset of what might be accepted by
// docker core or docker hub. If the name does not pass validation, an error, // docker core or docker hub. If the name does not pass validation, an error,
// describing the conditions, is returned. // describing the conditions, is returned.
//
// Effectively, the name should comply with the following grammar:
//
// alpha-numeric := /[a-z0-9]+/
// separator := /[._-]/
// component := alpha-numeric [separator alpha-numeric]*
// namespace := component ['/' component]*
//
// The result of the production, known as the "namespace", should be limited
// to 255 characters.
func ValidateRespositoryName(name string) error { func ValidateRespositoryName(name string) error {
if len(name) > RepositoryNameTotalLengthMax { if len(name) > RepositoryNameTotalLengthMax {
return ErrRepositoryNameLong return ErrRepositoryNameLong