A few "Who/Where" questions ahead of a community REST API

Adrien Glauser

12 Jul 2021 12 Jul '21

08:23

Dear Heroes, As mentioned in the last Heroes meeting we (Jens, Martín and I) are looking into building a user-friendly REST API to allow users across the entire platforms (web, Matrix, Telegram, Discord, future forums) to perform a variety of queries. The ultimate goal is to make important community tools and services more accessible by providing a single, user-friendly interface where basically any question that doesn't need a human respondent can be addressed by a simple query. (That's half the of it; it other half is to make channels, people and activities more discoverable, but that's for another day.) The domain of resources we want to provide access to is evolving as we learn new things about oS infra but it goes roughly like: - packages listed under "zypper search" - packages displayed on build.opensuse.org - documentation - the opensue bugzilla - progress/pagure - community news & activities (from news-o-o) and more. Now before we start building new tools we'd like to see if we can use tools that exist already. Thus we would like to know a few things: 1) Since this API is likely to depend on bots to provide in-app searches, we need to know if the bots bridging between the various instant messaging services could be used to forward queries to the API. Who's maintaining that / these bots and where can read the code? 2) Bugzilla comes with a REST API from version 5+; does bugzilla.opensuse.org have this feature currently enabled? Who should we get in touch with to negotiate enabling it? 3) Does Progress expose an API for doing queries and if yes, where's the docs about using this feature? Thanks a lot, any piece of information would be greatly appreciated! Best, Adrien

Attachments:

OpenPGP_0x22AC0A3867A088E6.asc (application/pgp-keys — 3.1 KB)
OpenPGP_signature.sig (application/pgp-signature — 840 bytes)

Show replies by date

Neal Gompa

12 Jul 12 Jul

11:31

On Mon, Jul 12, 2021 at 4:23 AM Adrien Glauser wrote:

...

Dear Heroes,

As mentioned in the last Heroes meeting we (Jens, Martín and I) are looking into building a user-friendly REST API to allow users across the entire platforms (web, Matrix, Telegram, Discord, future forums) to perform a variety of queries. The ultimate goal is to make important community tools and services more accessible by providing a single, user-friendly interface where basically any question that doesn't need a human respondent can be addressed by a simple query. (That's half the of it; it other half is to make channels, people and activities more discoverable, but that's for another day.)

The domain of resources we want to provide access to is evolving as we learn new things about oS infra but it goes roughly like: - packages listed under "zypper search" - packages displayed on build.opensuse.org - documentation - the opensue bugzilla - progress/pagure - community news & activities (from news-o-o) and more.

Now before we start building new tools we'd like to see if we can use tools that exist already. Thus we would like to know a few things:

1) Since this API is likely to depend on bots to provide in-app searches, we need to know if the bots bridging between the various instant messaging services could be used to forward queries to the API. Who's maintaining that / these bots and where can read the code?

Today, openSUSE Heroes has no bots in service beyond the bridge bots for the Matrix server.

...

2) Bugzilla comes with a REST API from version 5+; does bugzilla.opensuse.org have this feature currently enabled? Who should we get in touch with to negotiate enabling it?

We do not have Bugzilla 5. Sasi and I had been looking at trying to get SUSE IT to deploy a variant of the Red Hat Bugzilla 5 software[1] as it provides a variant of Bugzilla 5 with features that would be useful for distributions (including tracking third-party bug trackers and multi-SSO). Today, we have Bugzilla 4 with its XML-RPC API. I strongly recommend using python-bugzilla[2] to interface with it.

...

3) Does Progress expose an API for doing queries and if yes, where's the docs about using this feature?

Progress uses Redmine, however the project does not generally use this much, so it's not of much use to query for the project as a whole. That said, we *can* enable the REST API[3] if desired (if it's not already enabled, I'm not sure). Pagure has an API, and it's documentation is on the instance itself[4].

...

Thanks a lot, any piece of information would be greatly appreciated!

Hope this helps! [1]: https://pagure.io/Red-Hat-Bugzilla/rh-bugzilla [2]: https://github.com/python-bugzilla/python-bugzilla [3]: https://www.redmine.org/projects/redmine/wiki/rest_api [4]: https://code.opensuse.org/api -- 真実はいつも一つ！/ Always, there's only one truth!

Adrien Glauser

12:53

Thank you very much Neal, this is immensely helpful!

...

Today, openSUSE Heroes has no bots in service beyond the bridge bots for the Matrix server.

Indeed, it is about the bridge bots that I am asking: Can we take a look at the code currently in production? It might be possible to use these bots as a point of entry for allowing users to consume the future API from any bridged channel while avoiding duplicate responses. And should we use another bot instead, looking at the bots currently in use would still be instructive.

...

...
We do not have Bugzilla 5. Sasi and I had been looking at trying to get SUSE IT to deploy a variant of the Red Hat Bugzilla 5 software[1] as it provides a variant of Bugzilla 5 with features that would be useful for distributions (including tracking third-party bug trackers and multi-SSO).

Today, we have Bugzilla 4 with its XML-RPC API. I strongly recommend using python-bugzilla[2] to interface with it.

3) Does Progress expose an API for doing queries and if yes, where's the docs about using this feature?

Progress uses Redmine, however the project does not generally use this much, so it's not of much use to query for the project as a whole. That said, we *can* enable the REST API[3] if desired (if it's not already enabled, I'm not sure). Pagure has an API, and it's documentation is on the instance itself[4].

Duly noted about Progress. May we request API keys for both Pagure and the openSUSE bugzilla right now? Or shall I open a ticket or something to make it more official? Gratefully yours, Adrien

Neal Gompa

12:58

On Mon, Jul 12, 2021 at 8:54 AM Adrien Glauser wrote:

...

Thank you very much Neal, this is immensely helpful!

...
Today, openSUSE Heroes has no bots in service beyond the bridge bots for the Matrix server.

Indeed, it is about the bridge bots that I am asking: Can we take a look at the code currently in production? It might be possible to use these bots as a point of entry for allowing users to consume the future API from any bridged channel while avoiding duplicate responses. And should we use another bot instead, looking at the bots currently in use would still be instructive.

Sasi knows more here, but our deployment is documented in Salt: https://code.opensuse.org/heroes/salt/blob/production/f/pillar/role/matrix.s...

...

...
...
We do not have Bugzilla 5. Sasi and I had been looking at trying to get SUSE IT to deploy a variant of the Red Hat Bugzilla 5 software[1] as it provides a variant of Bugzilla 5 with features that would be useful for distributions (including tracking third-party bug trackers and multi-SSO).

Today, we have Bugzilla 4 with its XML-RPC API. I strongly recommend using python-bugzilla[2] to interface with it.

3) Does Progress expose an API for doing queries and if yes, where's the docs about using this feature?

Progress uses Redmine, however the project does not generally use this much, so it's not of much use to query for the project as a whole. That said, we *can* enable the REST API[3] if desired (if it's not already enabled, I'm not sure). Pagure has an API, and it's documentation is on the instance itself[4].

Duly noted about Progress. May we request API keys for both Pagure and the openSUSE bugzilla right now? Or shall I open a ticket or something to make it more official?

I don't know about Bugzilla, someone else on the team with more familiarity will have to chime in here. As for Pagure, API keys are self-service: https://code.opensuse.org/settings#nav-api-tab API keys are not required for read operations on public projects. -- 真実はいつも一つ！/ Always, there's only one truth!

Simon Lees

14 Jul 14 Jul

06:06

On 7/12/21 10:28 PM, Neal Gompa wrote:

...

On Mon, Jul 12, 2021 at 8:54 AM Adrien Glauser wrote:

...
Thank you very much Neal, this is immensely helpful!

...
Today, openSUSE Heroes has no bots in service beyond the bridge bots for the Matrix server.

Indeed, it is about the bridge bots that I am asking: Can we take a look at the code currently in production? It might be possible to use these bots as a point of entry for allowing users to consume the future API from any bridged channel while avoiding duplicate responses. And should we use another bot instead, looking at the bots currently in use would still be instructive.

Sasi knows more here, but our deployment is documented in Salt: https://code.opensuse.org/heroes/salt/blob/production/f/pillar/role/matrix.s...

...
...
...
We do not have Bugzilla 5. Sasi and I had been looking at trying to get SUSE IT to deploy a variant of the Red Hat Bugzilla 5 software[1] as it provides a variant of Bugzilla 5 with features that would be useful for distributions (including tracking third-party bug trackers and multi-SSO).

Today, we have Bugzilla 4 with its XML-RPC API. I strongly recommend using python-bugzilla[2] to interface with it.

3) Does Progress expose an API for doing queries and if yes, where's the docs about using this feature?

Progress uses Redmine, however the project does not generally use this much, so it's not of much use to query for the project as a whole. That said, we *can* enable the REST API[3] if desired (if it's not already enabled, I'm not sure). Pagure has an API, and it's documentation is on the instance itself[4].

Duly noted about Progress. May we request API keys for both Pagure and the openSUSE bugzilla right now? Or shall I open a ticket or something to make it more official?

I don't know about Bugzilla, someone else on the team with more familiarity will have to chime in here.

From memory python-bugzilla uses user auth rather then an API key, I think we handle bots by just creating a separate IDP account for them and logging in with that, its been a couple of years since I have used it though. Also be warned it isn't great for handling large number of requests at one time. -- Simon Lees (Simotek) http://simotek.net Emergency Update Team keybase.io/simotek SUSE Linux Adelaide Australia, UTC+10:30 GPG Fingerprint: 5B87 DB9D 88DC F606 E489 CEC5 0922 C246 02F0 014B

Adrien Glauser

15 Jul 15 Jul

09:03

Hey Simons, thanks for this addendum. Who should I get in touch with to create this IDP account? Also, we anticipate that implementing a good caching strategy will be our main job in the short run. Are there /Redis/ instances that SUSE or openSUSE could provide us with? Setting up our own server or using a cloud solution is not likely to cut it... Thanks, Adrien Le 14/07/2021 à 08:06, Simon Lees a écrit :

...

...
On Mon, Jul 12, 2021 at 8:54 AM Adrien Glauser wrote:

...
Thank you very much Neal, this is immensely helpful!

...
Today, openSUSE Heroes has no bots in service beyond the bridge bots for the Matrix server. Indeed, it is about the bridge bots that I am asking: Can we take a look at the code currently in production? It might be possible to use these bots as a point of entry for allowing users to consume the future API from any bridged channel while avoiding duplicate responses. And should we use another bot instead, looking at the bots currently in use would still be instructive.

Sasi knows more here, but our deployment is documented in Salt: https://code.opensuse.org/heroes/salt/blob/production/f/pillar/role/matrix.s...

...
...
...
We do not have Bugzilla 5. Sasi and I had been looking at trying to get SUSE IT to deploy a variant of the Red Hat Bugzilla 5 software[1] as it provides a variant of Bugzilla 5 with features that would be useful for distributions (including tracking third-party bug trackers and multi-SSO).

Today, we have Bugzilla 4 with its XML-RPC API. I strongly recommend using python-bugzilla[2] to interface with it.

3) Does Progress expose an API for doing queries and if yes, where's the docs about using this feature?

Progress uses Redmine, however the project does not generally use this much, so it's not of much use to query for the project as a whole. That said, we *can* enable the REST API[3] if desired (if it's not already enabled, I'm not sure). Pagure has an API, and it's documentation is on the instance itself[4]. Duly noted about Progress. May we request API keys for both Pagure and the openSUSE bugzilla right now? Or shall I open a ticket or something to make it more official?

I don't know about Bugzilla, someone else on the team with more familiarity will have to chime in here. From memory python-bugzilla uses user auth rather then an API key, I

On 7/12/21 10:28 PM, Neal Gompa wrote: think we handle bots by just creating a separate IDP account for them and logging in with that, its been a couple of years since I have used it though. Also be warned it isn't great for handling large number of requests at one time.

Simon Lees

19 Jul 19 Jul

00:32

On 7/15/21 6:33 PM, Adrien Glauser wrote:

...

Hey Simons, thanks for this addendum. Who should I get in touch with to create this IDP account?

This is just a standard bugzilla / obs account, all you should need is an email address, obviously if its for a community service it would be best if its an email address that multiple people in the community can eventually have access to.

...

Also, we anticipate that implementing a good caching strategy will be our main job in the short run. Are there /Redis/ instances that SUSE or openSUSE could provide us with? Setting up our own server or using a cloud solution is not likely to cut it...

Ill leave this question for someone else on the list, its something I know nothing about, I know about bugzilla because my team uses it at times for some internal scripts.

...

Le 14/07/2021 à 08:06, Simon Lees a écrit :

...
...
On Mon, Jul 12, 2021 at 8:54 AM Adrien Glauser wrote:

...
Thank you very much Neal, this is immensely helpful!

...
Today, openSUSE Heroes has no bots in service beyond the bridge bots for the Matrix server. Indeed, it is about the bridge bots that I am asking: Can we take a look at the code currently in production? It might be possible to use these bots as a point of entry for allowing users to consume the future API from any bridged channel while avoiding duplicate responses. And should we use another bot instead, looking at the bots currently in use would still be instructive.

Sasi knows more here, but our deployment is documented in Salt: https://code.opensuse.org/heroes/salt/blob/production/f/pillar/role/matrix.s...

...
...
...
We do not have Bugzilla 5. Sasi and I had been looking at trying to get SUSE IT to deploy a variant of the Red Hat Bugzilla 5 software[1] as it provides a variant of Bugzilla 5 with features that would be useful for distributions (including tracking third-party bug trackers and multi-SSO).

Today, we have Bugzilla 4 with its XML-RPC API. I strongly recommend using python-bugzilla[2] to interface with it.

3) Does Progress expose an API for doing queries and if yes, where's the docs about using this feature?

Progress uses Redmine, however the project does not generally use this much, so it's not of much use to query for the project as a whole. That said, we *can* enable the REST API[3] if desired (if it's not already enabled, I'm not sure). Pagure has an API, and it's documentation is on the instance itself[4]. Duly noted about Progress. May we request API keys for both Pagure and the openSUSE bugzilla right now? Or shall I open a ticket or something to make it more official?

I don't know about Bugzilla, someone else on the team with more familiarity will have to chime in here. From memory python-bugzilla uses user auth rather then an API key, I

On 7/12/21 10:28 PM, Neal Gompa wrote: think we handle bots by just creating a separate IDP account for them and logging in with that, its been a couple of years since I have used it though. Also be warned it isn't great for handling large number of requests at one time.

-- Simon Lees (Simotek) http://simotek.net Emergency Update Team keybase.io/simotek SUSE Linux Adelaide Australia, UTC+10:30 GPG Fingerprint: 5B87 DB9D 88DC F606 E489 CEC5 0922 C246 02F0 014B