SVN adaptor

From EzForge EN

Contents 1 Resources definition 1.1 Repositories resource 1.2 Repository resource 1.3 Files resource 1.4 File resource

Resources definition

Repositories resource

• URI: http://domain.org/subversion/v0.1/url-subversion/repositories
• Operations:
  • GET: return the existing repositories in this Subversion server
  • POST, PUT, DELETE: not implemented
• Representation, XML returned in GET operation:

<repositories>
  <repository id="rep1">
     <name>ezforge</name>
     <uri xlink:type="simple" xlink:show="replace" 
      xlink:href="http://domain.org/subversion/v0.1/url-subversion/repositories/ezforge/">
      http://domain.org/subversion/v0.1/url-subversion/repositories/ezforge/
     </uri>
  </repository>
  <repository id="rep2">
     <name>vulcano</name>
     <uri xlink:type="simple" xlink:show="replace" 
      xlink:href="http://domain.org/subversion/v0.1/url-subversion/repositories/vulcano/">
      http://domain.org/subversion/v0.1/url-subversion/repositories/vulcano/
     </uri>
  </repository>
</repositories>

Repository resource

• URIs, there are 2 possible URIs:
  • http://domain.org/subversion/v0.1/url-subversion/repositories/id_rep/ : current revision
  • http://domain.org/subversion/v0.1/url-subversion/repositories/id_rep/revisions/rev_number/ : specified revision
• Operations:
  • GET: obtains the content of the specified repository (id_rep)
  • POST: creates the specified repository in the SVN server
  • PUT, DELETE: not implemented
• Representation: XML returned in GET operation:

<repository id="rep1">
   <name>ezforge</name>
   <files>
      <uri xlink:type="simple" xlink:show="replace" 
       xlink:href="http://domain.org/subversion/v0.1/url-subversion/repositories/ezforge/files/">
       http://domain.org/subversion/v0.1/repositories/url-subversion/ezforge/files/
      </uri>
   </files>
</repository>

Note that in case that one revision has been specified, the URI linking to files has to 
include "/revisions/rev_number/" too

Files resource

• URIs, there are 2 possible URIs:
  • http://domain.org/subversion/v0.1/url-subversion/repositories/id_rep/files/ : current revision
  • http://domain.org/subversion/v0.1/url-subversion/repositories/id_rep/revisions/rev_number/files/ : specified revision
• Operations:
  • GET: return the existing files in the root directory of this Subversion server repository
  • POST, PUT, DELETE: not implemented
• Representation, XML returned in GET operation:

<files>
  <file id="docs">
     <name>docs</name>
     <uri xlink:type="simple" xlink:show="replace" 
      xlink:href="http://domain.org/subversion/v0.1/url-subversion/repositories/ezforge/files/docs/">
      http://domain.org/subversion/v0.1/url-subversion/repositories/ezforge/files/docs/
     </uri>
  </file>
  <file id="howto">
     <name>howto.txt</name>
     <uri xlink:type="simple" xlink:show="replace" 
      xlink:href="http://domain.org/subversion/v0.1/url-subversion/repositories/ezforge/files/howto/">
      http://domain.org/subversion/v0.1/url-subversion/repositories/ezforge/files/howto/
     </uri>
  </file>
</files>

Note that in case that one revision has been specified, the URI linking to files has to 
include "/revisions/rev_number/" too

File resource

• URIs, there are 2 possible URIs:
  • http://domain.org/subversion/v0.1/url-subversion/repositories/id_rep/files/file_path/ : current revision
  • http://domain.org/subversion/v0.1/url-subversion/repositories/id_rep/revisions/rev_number/files/file_path/ : specified revision
• Operations:
  • GET: obtains the content of the specified file (file_path)
  • POST, PUT, DELETE: not implemented
• Representation: XML returned in GET operation, there are 2 possible representation depending on the type of file (file or directory):

File representation:
<file id="file1">
   <name>view.py</name>
   <path>/dir1/dir2/view.py</path>
   <type>file</type>
   <content>the content of the file, maybe encapsulated in CDATA</content>
</file>

Directory representation:
<file id="dir2">
  <name>dir2</name>
  <path>/dir1/dir2</path>
  <type>directory</type>
  <content>
    <file id="dir3">
      <name>dir3</name>
      <uri xlink:type="simple" xlink:show="replace"               
       xlink:href="http://domain.org/subversion/v0.1/url-subversion/repositories/ezforge/files/dir1/dir2/dir3/">
       http://domain.org/subversion/v0.1/url-subversion/repositories/ezforge/files/dir1/dir2/dir3/
      </uri>
    </file>
    <file id="file34">
      <name>prop.py</name>
      <uri xlink:type="simple" xlink:show="replace" 
       xlink:href="http://domain.org/subversion/v0.1/url-subversion/repositories/ezforge/dir1/dir2/prop.py/">
       http://domain.org/subversion/v0.1/url-subversion/repositories/ezforge/files/dir1/dir2/prop.py/
      </uri>
    </file>
  </content>
</file>

Note that in case that one revision has been specified, the URI linking to files has to 
include "/revisions/rev_number/" too