Merge branch '10534-go-systemd-sdnotify-v14' of https://github.com/wtsi-hgi/arvados
[arvados.git] / doc / api / schema / Repository.html.textile.liquid
index 7c23eff7b2a56290dcfc85ca0f8ae7c279f6c263..0f9b25ec2ce911be6a0f5a822c82ec5e8bc1e5a8 100644 (file)
@@ -6,33 +6,20 @@ title: Repository
 
 ...
 
-
-
-A **Repository** represents...
+A **Repository** represents a git repository hosted in an Arvados installation.
 
 h2. Methods
 
-See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
-
-API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/repositories@
-
-h2. Creation
-
-h3. Prerequisites
-
-Prerequisites for creating a Repository.
-
-h3. Side effects
-
-Side effects of creating a Repository.
+See "repositories":{{site.baseurl}}/api/methods/repositories.html
 
-h2. Resources
+h2. Resource
 
 Each Repository has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
 
 table(table table-bordered table-condensed).
 |_. Attribute|_. Type|_. Description|_. Example|
-|name|string|||
-|fetch_url|string|||
-|push_url|string|||
-|updated_at|datetime|||
+|name|string|The name of the repository on disk.  Repository names must begin with a letter and contain only alphanumerics.  Unless the repository is owned by the system user, the name must begin with the owner's username, then be separated from the base repository name with @/@.  You may not create a repository that is owned by a user without a username.|@username/project1@|
+|clone_urls|array|URLs from which the repository can be cloned. Read-only.|@["git@git.zzzzz.arvadosapi.com:foo/bar.git",
+ "https://git.zzzzz.arvadosapi.com/foo/bar.git"]@|
+|fetch_url|string|URL suggested as a fetch-url in git config. Deprecated. Read-only.||
+|push_url|string|URL suggested as a push-url in git config. Deprecated. Read-only.||