From: Olivier Lamy <olamy@apache.org>
Date: Wed, 21 May 2014 05:21:44 +0000 (+1000)
Subject: add doc on querying artifacts
X-Git-Tag: archiva-2.1.0~27
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=9254faf5549f5b7d3c150a70b8b29093efc3fe51;p=archiva.git

add doc on querying artifacts
---

diff --git a/archiva-docs/src/site/apt/userguide/querying-artifacts.apt b/archiva-docs/src/site/apt/userguide/querying-artifacts.apt
new file mode 100644
index 000000000..05dacc389
--- /dev/null
+++ b/archiva-docs/src/site/apt/userguide/querying-artifacts.apt
@@ -0,0 +1,51 @@
+ ------
+ Querying Artifacts
+ ------
+ Olivier Lamy
+ ------
+ 2014-05-21
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements.  See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership.  The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License.  You may obtain a copy of the License at
+~~
+~~   http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied.  See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+
+Querying Artifacts
+
+ Sometimes you only need to download artifacts using a query and via the command line
+
+* Query format
+
++------------------
+  wget "http://localhost:9091/archiva/restServices/archivaServices/searchService/artifact?g=org.apache.archiva&a=archiva-model&v=LATEST"
++------------------
+
+  Query parameters:
+
+  * g= groupId (mandatory)
+
+  * a= artifactId (mandatory)
+
+  * v= the version (or LATEST keyword) (mandatory)
+
+  * r= the repository (optional, if none all repositories available for reading for the current user are searched)
+
+
+
diff --git a/archiva-docs/src/site/site.xml b/archiva-docs/src/site/site.xml
index 1467a0e1a..e0d532cc1 100644
--- a/archiva-docs/src/site/site.xml
+++ b/archiva-docs/src/site/site.xml
@@ -79,6 +79,7 @@
       <item name="Deploying to repository"   href="/userguide/deploy.html" />
       <item name="Configuring Virtual Repositories"   href="/userguide/virtual-repositories.html" />
       <item name="Rss Feeds in Archiva"      href="/userguide/rss.html"/>
+      <item name="Querying Artifacts"        href="/userguide/querying-artifacts.html"/>
       <!-- not yet in new UI -->
       <!--item name="Audit Log Report"      href="/userguide/auditlog-report.html"/-->
     </menu>