Thanks Josh. It helped me a bit. I searched the source code to find /capture-admin/agents.xml endpoint.
I first browsed: /docs.html?path=/capture-admin but I have not found it. Then searched the code. Now I opened: /capture-admin/?_wadl&_type=xml and there is is. It is up to date, and /docs.html?path=/capture-admin is not. ------- Josh, I think you are one of the crutial people in this project, so I address this one to you probably: 1.] Assumming that I have some engineering time, that I want to spend on Matterhorn [for example: adding an option to remove a servies from Admin Tools]. -Where can I find information that will actually allow me to add the changes and commit the code. 2.] Is there a place where I can read more about tricks like: /capture-admin/?_wadl&_type=xml 3.] I have a feeling that current spec is not sufficient. I actually have to browse the source code. Do you agree with me, or is there a place where I can read about it, and learn that it is sufficient. 4.] I want to register my capture agent using /capture-admin/agent rest endpoint. I have to pass XML file there with bunch of tags inside. Some are simple like <name>. Where can I learn about it that capture agent's name cannot contain spaces. Where can I learn about the content of "<capabilities>" 5.] If this spec is necesseary than I am interested in builing it. This probablty be a large HTML file like: http://v4l2spec.bytesex.org/spec-single/v4l2.html I will need help with editing it (I could use a native speaker), explaining the details and approval from Matterhorn's community that this API will be respected. That nobody will change REST endpoint without earlier aproving change to the API, and updateing the document. Please: do not say "if you're interested in putting together diagrams and other forms of documentation, I'm sure that would be appreciated!" Explain me how can I start doing this? You want me to create an HTML file and send it to you - you will edit it and put it on Matterhorn wiki pages? I cannot do it right now by myself. -Pawel --- On Wed, 9/14/11, Josh Holtzman <[email protected]> wrote: > From: Josh Holtzman <[email protected]> > Subject: Re: [Opencast Matterhorn] Matterhorn's design > To: "Opencast Matterhorn" <[email protected]> > Date: Wednesday, September 14, 2011, 4:06 PM > The docs are the human-readable > format of the REST API. They were designed to help > developers quickly and easily integrate. It sounds > like you want a more formal description of these services, > which we povide in the form of Web Application Description > Language (WADL): > > http://en.wikipedia.org/wiki/Web_Application_Description_Language > > For example, WADL for the human readable docs at > http://[matterhorn server]/workflow/docs there is a > WADL at http://[matterhorn > server]/workflow/?_wadl&_type=xml > > In the docs, search for the phrase "Returned entity schema" > and click the link next to it: this provides the XML > schema of the object returned by this endpoint. > > I understand that coming into the project at this point can > be difficult. But you should not have to read through > the code to integrate with Matterhorn's REST > endpoints. If the endpoints are not properly > documented, or are confusing, please file bugs and if > possible, suggest language to make them clearer. > > That said, if you're interested in putting together > diagrams and other forms of documentation, I'm sure that > would be appreciated! > > Josh > _______________________________________________ Matterhorn mailing list [email protected] http://lists.opencastproject.org/mailman/listinfo/matterhorn To unsubscribe please email [email protected] _______________________________________________
