1923N/A.. CDDL HEADER START
1923N/A
1923N/A.. The contents of this file are subject to the terms of the
1923N/A Common Development and Distribution License (the "License").
1923N/A You may not use this file except in compliance with the License.
1923N/A
1923N/A.. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
1923N/A or http://www.opensolaris.org/os/licensing.
1923N/A See the License for the specific language governing permissions
1923N/A and limitations under the License.
1923N/A
1923N/A.. When distributing Covered Code, include this CDDL HEADER in each
1923N/A file and include the License file at usr/src/OPENSOLARIS.LICENSE.
1923N/A If applicable, add the following below this CDDL HEADER, with the
1923N/A fields enclosed by brackets "[]" replaced with your own identifying
1923N/A information: Portions Copyright [yyyy] [name of copyright owner]
1923N/A
1923N/A.. CDDL HEADER END
1923N/A
1923N/A
1923N/A.. Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
1923N/A
1923N/A
1923N/ADepot Operations
1923N/A----------------
1923N/A
1923N/A - versions
1923N/A Version 0:
1923N/A A GET operation that retrieves text data representing what operations
1923N/A are supported and version information about the depot server.
1923N/A
1923N/A Example:
1923N/A URL:
1923N/A http://pkg.opensolaris.org/versions/0/
1923N/A
1923N/A Expects:
1923N/A Nothing
1923N/A
1923N/A Returns:
1923N/A text/plain data containing the version of the pkg(5) software that
1923N/A the depot is based upon, a list of the operations currently
1923N/A supported, and the protocol version supported for each
1923N/A operation.
1923N/A
1923N/A Sample Output:
1923N/A pkg-server bfc04991436e
1923N/A info 0
1923N/A search 0
1923N/A versions 0
1923N/A catalog 0
1923N/A manifest 0
1923N/A add 0
1923N/A file 0
1923N/A abandon 0
1923N/A close 0
1923N/A open 0
1923N/A
1923N/AMetadata Operations
1923N/A-------------------
1923N/A
1923N/A - catalog
1923N/A Version 0:
1923N/A A GET operation that retrieves a text/plain datastream
1923N/A representing a complete catalog or an incremental update to an
1923N/A existing one as requested.
1923N/A
1923N/A Example:
1923N/A URL:
1923N/A http://pkg.opensolaris.org/catalog/0/
1923N/A
1923N/A Expects:
1923N/A Nothing or the following headers:
1923N/A If-Modified-Since: {ISO 8601 formatted date and time in UTC}
1923N/A
1923N/A Returns:
1923N/A Either the contents of a pkg(5) catalog file, or the entries
1923N/A that were added since the specified date as they are found
1923N/A in the catalog file, separated by newlines.
1923N/A
1923N/A - info
1923N/A Version 0:
1923N/A A GET operation that retrieves a text/plain description of a
1923N/A package and its licensing information specified by the provided
1923N/A FMRI.
1923N/A
1923N/A Example:
1923N/A URL:
1923N/A http://pkg.opensolaris.org/info/0/entire@0.5.11,5.11-0.101:20081119T235706Z
1923N/A
1923N/A Expects:
1923N/A A URL-encoded pkg(5) FMRI, excluding the 'pkg:/' scheme prefix
1923N/A and publisher information, and including the full version
1923N/A information.
1923N/A
1923N/A Returns:
1923N/A A text/plain representation of the specified package and its
1923N/A licensing information.
1923N/A
1923N/A Sample Output:
1923N/A Name: entire
1923N/A Summary: entire incorporation
1923N/A Publisher: Unknown
1923N/A Version: 0.5.11
1923N/A Build Release: 5.11
1923N/A Branch: 0.101
1923N/A Packaging Date: Wed Nov 19 23:57:06 2008
1923N/A Size: 0.00 B
1923N/A FMRI: pkg:/entire@0.5.11,5.11-0.101:20081119T235706Z
1923N/A
1923N/A License:
1923N/A
1923N/A - manifest
1923N/A Version 0:
1923N/A A GET operation that retrieves the contents of the manifest file for
1923N/A a package specified by the provided FMRI.
1923N/A
1923N/A Example:
1923N/A URL:
1923N/A http://pkg.opensolaris.org/manifest/0/entire@0.5.11,5.11-0.101:20081119T235706Z
1923N/A
1923N/A Expects:
1923N/A A URL-encoded pkg(5) FMRI excluding the 'pkg:/' scheme prefix
1923N/A and publisher information and including the full version
1923N/A information.
1923N/A
1923N/A Returns:
1923N/A The contents of the package's manifest file.
1923N/A
1923N/A - p5i
1923N/A Version 0:
1923N/A A GET operation that retrieves an application/vnd.pkg5.info
1923N/A datastream representing publisher and package information.
1923N/A This is intended for consumption by clients for the purposes
1923N/A of auto-configuration, metadata management policy determination,
1923N/A and triggering packaging operations such as installation.
1923N/A
1923N/A Example:
1923N/A URL:
1923N/A http://pkg.opensolaris.org/release/p5i/0/SUNWcs
1923N/A
1923N/A Expects:
1923N/A A full or partial URL-encoded pkg(5) FMRI, excluding the
1923N/A publisher prefix. If the partial or full FMRI is valid, it will
1923N/A be added to the datastream as is. If it includes the wildcard
1923N/A character '*', a search of the repository's catalog for matching
1923N/A entries will be performed and the unique set of resulting
1923N/A package stems will be added to the datastream. If no match is
1923N/A found, a 404 error will be raised.
1923N/A
1923N/A Returns:
1923N/A Returns a pkg(5) information datastream based on the repository
1923N/A configuration's publisher information and the provided full or
1923N/A partial FMRI or matching entries. The Content-Type of the
1923N/A response is 'application/vnd.pkg5.info'.
1923N/A
1923N/A - publisher
1923N/A Version 0:
1923N/A A GET operation that retrieves an application/vnd.pkg5.info
1923N/A datastream representing publisher information. This is intended
1923N/A for consumption by clients for auto-configuration and metadata
1923N/A management policy determination.
1923N/A
1923N/A Example:
1923N/A URL:
1923N/A http://pkg.opensolaris.org/release/publisher/0
1923N/A
1923N/A Expects:
1923N/A Nothing
1923N/A
1923N/A Returns:
1923N/A Returns a pkg(5) information datastream based on the repository
1923N/A configuration's publisher information. The Content-Type of the
1923N/A response is 'application/vnd.pkg5.info'.
1923N/A
1923N/A - search
1923N/A Version 0:
1923N/A A GET operation that retrieves a text/plain list of packages with
1923N/A metadata that matches the specified criteria.
1923N/A
1923N/A Example:
1923N/A URL:
1923N/A http://pkg.opensolaris.org/release/search/0/vim
1923N/A
1923N/A Expects:
1923N/A A URL-encoded token representing the search criteria.
1923N/A
1923N/A Returns:
1923N/A A text/plain list of matching entries, separated by newlines.
1923N/A Each entry consists of a set of four space-separated values:
1923N/A
1923N/A index - what search index the entry was found in
1923N/A
1923N/A action - what package action the entry is related to
1923N/A
1923N/A value - the value that the matched the search criteria
1923N/A
1923N/A package - the fmri of the package that contains the match
1923N/A
1923N/A Results are streamed to the client as they are found.
1923N/A
1923N/A Sample Output:
1923N/A basename pkg:/SUNWvim@7.1.284,5.11-0.101:20081119T230659Z dir usr/share/vim
1923N/A basename pkg:/SUNWvim@7.1.284,5.11-0.93:20080708T171331Z file usr/bin/vim
1923N/A
1923N/AContent Operations
1923N/A------------------
1923N/A
1923N/A The pkg.depotd(5) server provides the following operations for retrieving
1923N/A package content:
1923N/A
1923N/A - file
1923N/A Version 0:
1923N/A A GET operation that retrieves the contents of a file, belonging to a
1923N/A package, using a SHA-1 hash of the file's content.
1923N/A
1923N/A Example:
1923N/A URL:
1923N/A http://pkg.opensolaris.org/release/file/0/
1923N/A a00030db8b91f85d0b7144d0d4ef241a3f1ae28f
1923N/A
1923N/A Expects:
1923N/A A SHA-1 hash of the file's content belonging to a package in the
1923N/A request path.
1923N/A
1923N/A Returns:
1923N/A The contents of the file, compressed using the gzip compression
1923N/A algorithm.
1923N/A