Scio: documenting SOAP services

Scio includes a Sphinx extension, scio.autowsdl, that you can use to automatically document SOAP services defined in wsdl files.

To use autowsdl, include it in your conf.py:

extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
              'sphinx.ext.intersphinx', 'scio.autowsdl']

Then in a source reST document processed by Sphinx, include a declaration like:

.. autowsdl: path/to/wsdl_file.wsdl
   :namespace: stuffz

The generated documentation looks like the example below. The classes documented will be given a pseudo-module namespace to avoid collisions when generating documentation for multiple wsdl files. By default, the namespace is the basename of the wsdl file, with the file extension removed. If you want to customize the namespace, set the :namespace: option in the .. autowsdl block.

Example: LyricWiki

Web Service: urn:LyricWiki

Methods

Methods are accessible under the service attribute of a client instance.

lyricwiki.checkSongExists(artist, song)

Parameters:

• artist – lyricwiki.StringType
• song – lyricwiki.StringType

Return type:

lyricwiki.BooleanType

lyricwiki.getAlbum(artist, album, year)

Parameters:

• artist – lyricwiki.StringType
• album – lyricwiki.StringType
• year – lyricwiki.IntType

Return type:

(lyricwiki.StringType, lyricwiki.StringType, lyricwiki.IntType, lyricwiki.StringType, lyricwiki.ArrayOfstring)

lyricwiki.getArtist(artist)

Parameters:artist – lyricwiki.StringType Return type:(lyricwiki.StringType, lyricwiki.AlbumDataArray)

lyricwiki.getHometown(artist)

Parameters:artist – lyricwiki.StringType Return type:(lyricwiki.StringType, lyricwiki.StringType, lyricwiki.StringType)

lyricwiki.getSong(artist, song)

Parameters:

• artist – lyricwiki.StringType
• song – lyricwiki.StringType

Return type:

lyricwiki.LyricsResult

lyricwiki.getSongResult(artist, song)

Parameters:

• artist – lyricwiki.StringType
• song – lyricwiki.StringType

Return type:

lyricwiki.LyricsResult

lyricwiki.postAlbum(overwriteIfExists, artist, album, year, asin, songs)

Parameters:

• overwriteIfExists – lyricwiki.BooleanType
• artist – lyricwiki.StringType
• album – lyricwiki.StringType
• year – lyricwiki.IntType
• asin – lyricwiki.StringType
• songs – lyricwiki.ArrayOfstring

Return type:

(lyricwiki.StringType, lyricwiki.StringType, lyricwiki.IntType, lyricwiki.BooleanType, lyricwiki.StringType)

lyricwiki.postArtist(overwriteIfExists, artist, albums)

Parameters:

• overwriteIfExists – lyricwiki.BooleanType
• artist – lyricwiki.StringType
• albums – lyricwiki.AlbumDataArray

Return type:

(lyricwiki.StringType, lyricwiki.BooleanType, lyricwiki.StringType)

lyricwiki.postSong(overwriteIfExists, artist, song, lyrics, onAlbums)

Parameters:

• overwriteIfExists – lyricwiki.BooleanType
• artist – lyricwiki.StringType
• song – lyricwiki.StringType
• lyrics – lyricwiki.StringType
• onAlbums – lyricwiki.AlbumResultArray

Return type:

(lyricwiki.StringType, lyricwiki.StringType, lyricwiki.BooleanType, lyricwiki.StringType)

lyricwiki.postSong_flags(overwriteIfExists, artist, song, lyrics, onAlbums, flags)

Parameters:

• overwriteIfExists – lyricwiki.BooleanType
• artist – lyricwiki.StringType
• song – lyricwiki.StringType
• lyrics – lyricwiki.StringType
• onAlbums – lyricwiki.AlbumResultArray
• flags – lyricwiki.StringType

Return type:

(lyricwiki.StringType, lyricwiki.StringType, lyricwiki.BooleanType, lyricwiki.StringType)

lyricwiki.searchAlbums(artist, album, year)

Parameters:

• artist – lyricwiki.StringType
• album – lyricwiki.StringType
• year – lyricwiki.IntType

Return type:

lyricwiki.AlbumResultArray

lyricwiki.searchArtists(searchString)

Parameters:searchString – lyricwiki.StringType Return type:lyricwiki.ArrayOfstring

lyricwiki.searchSongs(artist, song)

Parameters:

• artist – lyricwiki.StringType
• song – lyricwiki.StringType

Return type:

lyricwiki.SongResult

Types

Types are accessible under the type attribute of a client instance.

class lyricwiki.AlbumData

album

type: lyricwiki.StringType

year

type: lyricwiki.IntType

amazonLink

type: lyricwiki.StringType

songs

type: lyricwiki.ArrayOfstring

class lyricwiki.AlbumDataArray

class lyricwiki.AlbumResult

artist

type: lyricwiki.StringType

album

type: lyricwiki.StringType

year

type: lyricwiki.IntType

class lyricwiki.AlbumResultArray

class lyricwiki.ArrayOfstring

class lyricwiki.LyricsResult

artist

type: lyricwiki.StringType

song

type: lyricwiki.StringType

lyrics

type: lyricwiki.StringType

url

type: lyricwiki.StringType

class lyricwiki.SOTDResult

artist

type: lyricwiki.StringType

song

type: lyricwiki.StringType

nominatedBy

type: lyricwiki.StringType

reason

type: lyricwiki.StringType

lyrics

type: lyricwiki.StringType

class lyricwiki.SongResult

artist

type: lyricwiki.StringType

song

type: lyricwiki.StringType