Re: open questions about pear's REST interface to channels
| From: | Brett Bieber | Date: | Wed, 16 Apr 2008 04:18:06 +0000 |
| Subject: | Re: open questions about pear's REST interface to channels | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-49802@lists.php.net to get a copy of this message | ||
Hey Christian,
Good work on the REST docs... I've tried to answer your questions to
the best of my knowledge. Hopefully someone can correct me if I'm
wrong.
> While writing the documents for the REST interface in peardoc, I
> stumbled about some sections lacking clarity. Maybe someone could help:
>
> - r/$package/stable.txt
> - r/$package/beta.txt
> - r/$package/alpha.txt
> - r/$package/devel.txt
> Do they exist if there is no stable/beta/alpha/devel version so that
> the access to the file results in a 404?
I don't think they exist --- why would they, and what would be the
contents? I think 404 is adequate here. One thing I'm wondering is,
are the .txt files just convenience files for the installer? I would
think anything official/required would be the xml files.
> - r/$package/latest.txt
> Does that list the most recently released version, or the highest
> version?
> We currently have a problem with Chiara_PEAR_Server: stable version is
> 1.0.5, beta is 1.1.0b1. The stable version has been released *after*
> the beta, which in turn has the higher version number. Which one should
> be in latest.txt? The pear installer does not recognize the beta and
> always wants to install the stable version unless forced in combination
> with the direct version number.
>
> Does the file exist when there has been no release yet?
No clue... latest.txt seems like a convenience file... I'll search
tomorrow and see how it's used by the installer.
>
> - m/allmaintainers.xml
> The <h> tags - do they enclose the full name of a developer, or the
> nickname only? It currently seems like the nickname. If that's the
> case: Is the nickname lowercased?
The schema specifies that it can be any string, not restricted to a
token or casing. Anything should be fine as long as the xlink:href
points to the correct location where the info.xml file is.
> - m/${maintainernick}/info.xml
> Same question as above
In this file you can specify all the information about the maintainer
- h = handle, n = full name, u = uri to maintainer's homepage... all
of these are strings.
> - p/packages.xml
> How are spaces in package names handled? Are they allowed?
The schema says the name is a string field, but I would avoid spaces.
Unknown behavior as far as I know.
> - r/${packagename}/0.1.2.xml
> <f> contains the file size in bytes. Is it the size of the tar or the
> tgz?
The tgz
> It also has the maintainer handle in <m>. Which one is this? The one
> who released it? All leads?
The maintainer that released it.
> - r/${packagename}/deps.0.1.2.txt
> Is the array format described somewhere?
Eh... I'm not sure about this one. Probably should look into documenting it.
--
Brett Bieber
http://saltybeagle.com/