#2828 web: additional info on API page
Merged a year ago by tkopecek. Opened a year ago by tkopecek.
tkopecek/koji issue2825  into  master

file modified
+20
@@ -3,6 +3,26 @@ 

  

  <h4>API reference <small>(hub version: $koji_version, web version: $koji.__version__)</small></h4>

  

+ Various constants used in API calls can be found in first part of <a

+ href="https://pagure.io/koji/blob/master/f/koji/__init__.py">koji module</a>.

+ Exceptions which can be raised in python client are just after constants section.

+ 

+ Basic anonymous client in python would look like this:

+ 

+ <pre>

+ import koji

+ 

+ mytag = "mytag"

+ session = koji.ClientSession("$koji_hub_url")

+ try:

+     repo_info = session.getRepo(mytag, koji.REPO_STATES["READY"], dist=True)

+     if not repo_info:

+         print(f"There is no active dist repo for {mytag}")

+ except koji.GenericError:

+     print(f"Tag {mytag} doesn't exist")

+ </pre>

+ 

+ <h4>List of API calls</h4>

  <ul>

  #for method in $methods

    <li>

file modified
+1
@@ -2517,6 +2517,7 @@ 

      values = _initValues(environ, 'API', 'api')

      server = _getServer(environ)

  

+     values['koji_hub_url'] = environ['koji.options']['KojiHubURL']

      values['methods'] = sorted(server._listapi(), key=lambda x: x['name'])

      try:

          values['koji_version'] = server.getKojiVersion()

rebased onto e9d008cff35bcdc3530a87ccd1ced53e0034088e

a year ago

1 new commit added

  • fix typo
a year ago

rebased onto a1e2d38

a year ago

Metadata Update from @tkopecek:
- Pull-request tagged with: testing-ready

a year ago

Metadata Update from @jobrauer:
- Pull-request tagged with: testing-done

a year ago

Commit df09be4 fixes this pull-request

Pull-Request has been merged by tkopecek

a year ago