def genDocumentation(self, entry):
entry.set('/documentation/specification', self.se.get('/auto/documentation/wiki-url'))
entry.set('/documentation/devguide', self.se.get('/auto/documentation/devguide-url'))
entry.set('/documentation/installguide', self.se.get('/auto/documentation/installguide-url'))
entry.set('/documentation/api', self.se.get('/auto/documentation/api-url'))
additional = self.se.get('/auto/documentation/additional-resources')
entry.set('/documentation/additional-resources', additional)
if additional is None:
return
for url in additional:
sanitychecks.check_remote_resource(url, 'Probably invalid link to additional resource!')
def genDocumentation(self, entry):
entry.set('/documentation/specification',
self.se.get('/auto/documentation/wiki-url'))
entry.set('/documentation/devguide',
self.se.get('/auto/documentation/devguide-url'))
entry.set('/documentation/installguide',
self.se.get('/auto/documentation/installguide-url'))
entry.set('/documentation/api',
self.se.get('/auto/documentation/api-url'))
additional = self.se.get('/auto/documentation/additional-resources')
entry.set('/documentation/additional-resources', additional)
if additional is None:
return
for url in additional:
sanitychecks.check_remote_resource(
url, 'Probably invalid link to additional resource!')
def genTweak(self, entry):
repo = self.se.get('/auto/usage/playground/link')
if repo is not None:
repoparts = repo.rpartition('/')
suffix = repoparts[2]
tweak = self.playground_url + suffix
check = sanitychecks.check_remote_resource(repo + '/blob/master/playground.json', 'Probably invalid tweak link since no "playground.json" was found!')
self.index('playground', suffix, {'url': repo, 'se': self.se.get_name(), 'valid': check})
else:
tweak = None
entry.set('/usage/tweak', tweak)
def pub_se_api_url(self):
doxygen = self.se.get('/spec/documentation/api/doxygen')
if doxygen is not None:
return doxygen
jsdoc = self.se.get('/spec/documentation/api/jsdoc')
if jsdoc is not None:
return jsdoc
swagger = self.se.get('/spec/documentation/api/swagger')
if swagger is None:
swagger = 'http://fic2.github.io/swaggerfiles/%s/swagger.json' % self.nc.normalizedname()
if sanitychecks.check_remote_resource(swagger, 'No swagger.json found!'):
return '___SWAGGER___' + swagger
return None
def genTweak(self, entry):
repo = self.se.get("/auto/usage/playground/link")
if repo is not None:
repoparts = repo.rpartition("/")
suffix = repoparts[2]
tweak = JsonGenerator.playground_url + suffix
check = sanitychecks.check_remote_resource(
repo + "/blob/master/playground.json",
'Probably invalid tweak link since no "playground.json" was found!',
)
self.index("playground", suffix, {"url": repo, "se": self.se.get_name(), "valid": check})
else:
tweak = None
entry.set("/usage/tweak", tweak)
def pub_se_api_url(self):
doxygen = self.se.get('/spec/documentation/api/doxygen')
if doxygen is not None:
return doxygen
jsdoc = self.se.get('/spec/documentation/api/jsdoc')
if jsdoc is not None:
return jsdoc
swagger = self.se.get('/spec/documentation/api/swagger')
if swagger is None:
swagger = 'http://fic2.github.io/swaggerfiles/%s/swagger.json' % self.nc.normalizedname()
if self.se.get('/status') != 'deprecated':
if sanitychecks.check_remote_resource(swagger):
return '___SWAGGER___' + swagger
self.warning('No swagger.json found!')
return None
def genTweak(self, entry):
repo = self.se.get('/auto/usage/playground/link')
if repo is not None:
repoparts = repo.rpartition('/')
suffix = repoparts[2]
tweak = self.playground_url + suffix
check = sanitychecks.check_remote_resource(
repo + '/blob/master/playground.json',
'Probably invalid tweak link since no "playground.json" was found!'
)
self.index('playground', suffix, {
'url': repo,
'se': self.se.get_name(),
'valid': check
})
else:
tweak = None
entry.set('/usage/tweak', tweak)
def genTry(self, entry):
online_demo = self.se.get('/auto/usage/online-demo')
entry.set('/usage/try', online_demo)
if online_demo is not None:
sanitychecks.check_remote_resource(online_demo.get('/link'),
'Probably invalid try link!')
def genTry(self, entry):
online_demo = self.se.get("/auto/usage/online-demo")
entry.set("/usage/try", online_demo)
if online_demo is not None:
sanitychecks.check_remote_resource(online_demo.get("/link"), "Probably invalid try link!")
def genTry(self, entry):
online_demo = self.se.get('/auto/usage/online-demo')
entry.set('/usage/try', online_demo)
if online_demo is not None:
sanitychecks.check_remote_resource(online_demo.get('/link'), 'Probably invalid try link!')