fix(rust): add missing paths to the OpenAPI spec

[imobachgs]

The OpenAPI spec is not complete, as reported in #1700. This PR aims to add the missing pieces to the spec. As part of the work, I updated the utoipa dependency to version 5.2 which is much better when it comes to detect omissions and problems.

Tasks

• Add missing /api prefix.
• Add missing paths.
• Add missing components.
• Migrate to utoipa 5.
• Add the issues spec (postponed).

[lslezak]

I'm not a Rust or OpenAPI expert, but the change looks reasonable to me. 😄

[jreidinger]

now I am confused. it should have descriptuon from that MacAddr6 schema and also its value type should be read from it, not?

[imobachgs]

It should, but it does not work in that way. To make it work, I would need to convert the variant into a struct-based one:

pub enum MacAddress {
  MacAddress {
    address: macaddr::MacAddr6
  },
  Preserve,
  // etc.
}

Otherwise, the macro did not work (at least for me). I can change it, but I was unsure whether I should adapt the enum to the macro.

[mvidner]

Thanks! But :)
I want to test its output, but agama-web-server docs no longer works, and this feature is poorly discoverable: no "openapi" mentioned in any *.md file (and there are too many hits in the remaining files)
Please add a mention to rust/xtask/README.md I guess

[mvidner]

Yay, now I can see the paths that are wrongly missing the /api prefix:

cd rust
cargo xtask openapi
jq '.paths | keys' out/openapi/*json | grep -v /api | grep \"

gives me

  "/manager/logs/list",
  "/manager/logs/store"
  "/ping"
  "/network/connections/:id"

[imobachgs]

Thanks! But :) I want to test its output, but agama-web-server docs no longer works, and this feature is poorly discoverable: no "openapi" mentioned in any *.md file (and there are too many hits in the remaining files) Please add a mention to rust/xtask/README.md I guess

The OpenAPI spec are now generated at build time and packaged as agama-openapi under /usr/share/agama/openapi.

[imobachgs]

Yay, now I can see the paths that are wrongly missing the /api prefix:

cd rust
cargo xtask openapi
jq '.paths | keys' out/openapi/*json | grep -v /api | grep \"

gives me

  "/manager/logs/list",
  "/manager/logs/store"
  "/ping"
  "/network/connections/:id"

Good catch! I have fixed them.

[imobachgs]

@mvidner And about use cases, code generation for our own clients could be pretty interesting.