PR#2509: doc: api docs - koji

Tomas Kopecek • 2 years ago

7cc028e

hub/kojihub.py

file modified

		`@@ -10265,6 +10265,7 @@`
		`return make_task('image', [name, version, arches, target, inst_tree, opts], **taskOpts)`

		`def hello(self, *args):`
		`+ """Simple testing call returning a string"""`
		`return "Hello World"`

		`def fault(self):`
		`@@ -10290,9 +10291,11 @@`
		`return bool(context.opts.get('EnableWin'))`

		`def showSession(self):`
		`+ """Return string representation of session for current user"""`
		`return "%s" % context.session`

		`def getSessionInfo(self):`
		`+ """Return session info for current user"""`
		`if not context.session.logged_in:`
		`return None`
		`return context.session.session_data`

koji/auth.py

file modified

+20

		`@@ -748,6 +748,15 @@`


		`def login(args, *opts):`
		`+ """Create a login session with plain user/password credentials.`
		`+`
		`+ :param str user: username`
		`+ :param str password: password`
		`+ :param dict opts: curently can contain only 'host_ip' key for overriding client IP address`
		`+`
		`+ :returns dict: session info`
		`+ """`
		`+`
		`return context.session.login(args, *opts)`


		`@@ -756,18 +765,29 @@`


		`def sslLogin(args, *opts):`
		`+ """Login via SSL certificate`
		`+`
		`+ :param str proxyuser: proxy username`
		`+ :returns dict: session info`
		`+ """`
		`return context.session.sslLogin(args, *opts)`


		`def logout():`
		`+ """expire a login session"""`
		`return context.session.logout()`


		`def subsession():`
		`+ """Create a subsession"""`
		`return context.session.subsession()`


		`def logoutChild(session_id):`
		`+ """expire a subsession`
		`+`
		`+ :param int subsession_id: subsession ID (for current session)`
		`+ """`
		`return context.session.logoutChild(session_id)`