schemas/JalviewWsParamSet.xsd

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
   4  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
   5  *
   6  * This file is part of Jalview.
   7  *
   8  * Jalview is free software: you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  18 -->
  19 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  20         targetNamespace="www.jalview.org/xml/wsparamset">
  21         <xs:complexType name="WebServiceParameterSet">
  22                 <xs:sequence>
  23                         <xs:element name="Version" maxOccurs="1" minOccurs="0"
  24                                 type="xs:string">
  25                                 <xs:annotation>
  26                                         <xs:documentation>
  27                                                 A Jalview Web Service Parameter Set container
  28                                                 version number.
  29                                                 Version 1 created for storing Jaba user presets.
  30                                         </xs:documentation>
  31                                 </xs:annotation>
  32                         </xs:element>
  33                         <xs:element name="description" minOccurs="0" maxOccurs="1"
  34                                 type="xs:string">
  35                                 <xs:annotation>
  36                                         <xs:documentation>Short description - as utf8 encoded text. This is
  37                                                 usually displayed
  38                                                 in the body of an HTML capable tooltip, so HTML tags may be embedded
  39                                                 using standard UTF8 encoding.
  40                                         </xs:documentation>
  41                                 </xs:annotation>
  42                         </xs:element>
  43                         <xs:element name="serviceURL" minOccurs="1" maxOccurs="unbounded"
  44                                 type="xs:anyURI">
  45                                 <xs:annotation>
  46                                         <xs:documentation>
  47                                                 URL for which the parameter set is valid. Jalview will use it to
  48                                                 match up parameter sets to service instances that can parse the
  49                                                 parameter set payload.
  50                                 </xs:documentation>
  51                                 </xs:annotation>
  52                         </xs:element>
  53
  54                         <xs:element name="parameters" maxOccurs="1" minOccurs="1"
  55                                 type="xs:string">
  56                                 <xs:annotation>
  57                                         <xs:documentation>
  58                                                 UTF8 encoded string to be processed into a specific web services'
  59                                                 parameter set. Note - newlines may be important to the structure
  60                                                 of this file.
  61                                 </xs:documentation>
  62                                 </xs:annotation>
  63                         </xs:element>
  64                 </xs:sequence>
  65                 <xs:attribute name="name" type="xs:string" use="required">
  66                         <xs:annotation>
  67                                 <xs:documentation>
  68                                         The short name for the parameter set. This will be shown amongst the
  69                                         other presets for the web service.
  70                 </xs:documentation>
  71                         </xs:annotation>
  72                 </xs:attribute>
  73         </xs:complexType>
  74 </xs:schema>