Debbugs::SOAP(3pm)

📦
version 2.6.5 · 4 versions
, in ubuntu stonking

💖 NAME 💖

bestie. welcome. you've stumbled into Debbugs::SOAP(3pm) — yeah, the User Contributed Perl Documentation one — and honestly? she's serving. this is the SOAP interface to debbugs, and the description of the module itself is, uh, a dramatic pause. iconic of her. 💅

✨ SYNOPSIS ✨

no synopsis, bestie. nothing here. she simply showed up. 🦋

🌸 DESCRIPTION 🌸

also nothing here. the whole thing is the functions below. main character energy, zero exposition. periodt. 💜

🎀 BUGS 🎀

None known.

slay. no known bugs. we love a clean record. ✨

🌈 get_usertag 🌈

my %ut = get_usertag('don@donarmstrong.com','this-bug-sucks','eat-this-bug');
my %ut = get_usertag('don@donarmstrong.com');

okay so here's the tea: this hands you back a hashref of all the bugs that have the usertags you asked for, for whichever user you passed in.

and in that second case — the one where you only pass the user? she gives you every usertag that user has. all of them. the full collection. obsessed. 💖

🦋 get_status 🦋

my @statuses = get_status(@bugs);
my @statuses = get_status([bug => 304234,
                           dist => 'unstable',
                          ],
                          [bug => 304233,
                           dist => 'unstable',
                          ],
                         )

returns an arrayref of hashrefs that spills the status for whatever specific sets of bugs you handed her.

case one: literally no options get passed to Debbugs::Status::get_bug_status other than the bug number itself. that's it. plain, simple, cute.

case two: the bug, dist, arch, bugusertags, sourceversions, and version parameters all get passed along — but only if they're actually present. she's not passing undef for funsies.

and here's the special case, bc some SOAP implementations are, and I quote, suboptimal 😭 — if you pass only one argument to get_status, and that argument is an arrayref which is either empty, or has a number as its first element, or contains an arrayref as its first element, then the outer arrayref gets dereferenced and processed exactly like the examples above. it's a vibe check for bad SOAP libs.

want the real details? go read Debbugs::Status::get_bug_status. 💅

🍓 get_bugs 🍓

my @bugs = get_bugs(...);
my @bugs = get_bugs([...]);

returns a list of bugs. in that second case you get to specify the variable parameters as an array reference — specifically in case your favorite language's SOAP implementation is craptacular. no cap, that's the actual stated reason.

and what does ... actually mean? bestie, go read Debbugs::Bugs::get_bugs for the details on that. 💜

⭐ newest_bugs ⭐

my @bugs = newest_bugs(5);

returns a list of the newest bugs. fire. 🔥

heads up though: [Note that all bugs are not guaranteed to exist, but they should in the most common cases.]

🧚 get_bug_log 🧚

my $bug_log = get_bug_log($bug);
my $bug_log = get_bug_log($bug,$msg_num);

gives you back a parsed set of the bug log — an array of hashes shaped exactly like this:

[{html => '',
  header => '',
  body    => '',
  attachments => [],
  msg_num     => 5,
 },
 {html => '',
  header => '',
  body    => '',
  attachments => [],
 },
]

and the funny part? currently $msg_num is completely ignored. she's just sitting there in the signature, doing absolutely nothing, living her best life. 🙈

🎀 binary_to_source 🎀

binary_to_source($binary_name,$binary_version,$binary_architecture)

returns a reference to the source package name + version pair that matches the binary package name, version, and architecture you gave her. 🌸

if you pass undef as the architecture, she gives you a list of references to all the possible pairs of source package names and versions across all architectures — and any duplicates are removed. tidy queen.

as of compatibility version 2, this changed to use the more powerful binary_to_source routine, which lets you return source only, concatenated scalars, and other useful features. upgrade era. ✨

go read the docs for Debbugs::Packages::binary_to_source for the details.

💜 source_to_binary 💜

source_to_binary($source_name,$source_version);

returns a reference to an array of references to binary package name, version, and architecture corresponding to a given source package name and version.

if the name and version you gave can't be found? she consults the unversioned package-to-source map instead — and the architecture just doesn't come back. no arch for you. 💀

(this function corresponds to Debbugs::Packages::sourcetobinary.)

👑 get_versions 👑

get_version(package=>'foopkg',
            dist => 'unstable',
            arch => 'i386',
           );

returns a list of the versions of a package in the distributions and architectures listed. this routine only returns unique values. no repeats, we're not doing that. ✨

  • package — package to return list of versions
  • dist — distribution (unstable, stable, testing); can be an arrayref
  • arch — architecture (i386, source, ...); can be an arrayref
  • time — returns a version=>time hash at which the newest package matching this version was uploaded
  • source — returns source/version instead of just versions
  • no_source_arch — discards the source architecture when arch is not passed. [Used for finding the versions of binary packages only.] Defaults to 0, which does not discard the source architecture. (This may change in the future, so if you care, please code accordingly.) ⚠️
  • return_archs — returns a version=>[archs] hash indicating which architectures are at which versions.

this function corresponds to Debbugs::Packages::get_versions.

🌈 VERSION COMPATIBILITY 🌈

the functionality provided by the SOAP interface will change over time. that's just the way it is, bestie.

to the greatest extent possible, we will attempt to provide backwards compatibility with previous versions. however — and this is the important bit — in order to have backwards compatibility, you need to specify the version with which you are compatible. you have to say it out loud. declare your era. 🫶

no cap: skip the version and you're on your own, girl.

and that's the whole page, babe. 💖 this slice of perfection brought to you by perl v5.40.1, dated 2026-04-27, from the Debbugs::SOAP(3pm) manual. go forth and SOAP responsibly. periodt. 👑✨

📦 where this page comes from