Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiple path parameters from tuple are ignored #113

Open
tomas789 opened this issue Feb 13, 2024 · 3 comments
Open

Multiple path parameters from tuple are ignored #113

tomas789 opened this issue Feb 13, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@tomas789
Copy link

tomas789 commented Feb 13, 2024

When the path has multiple parameters, Axum supports two ways of passing them to the handler. First is to make a struct which is then parsed. This use case works well. Second is to accept it as tuple. Both cases presented in Axum documentation.

The tuple-based path is not handled properly by Aide. I have made a small change to the example to demonstrate the issue.

I defined two new handlers using both approaches. The function depends_on_todo_struct has its OpenAPI spec as follows

    "/todo/{id}/depends-on-with-struct/{depends_on_id}": {
      "put": {
        "description": "Todo depends on another Todo.",
        "parameters": [
          {
            "in": "path",
            "name": "depends_on_id",
            "description": "The ID of the Todo that this Todo depends on.",
            "required": true,
            "schema": {
              "description": "The ID of the Todo that this Todo depends on.",
              "type": "string",
              "format": "uuid"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the Todo.",
            "required": true,
            "schema": {
              "description": "The ID of the Todo.",
              "type": "string",
              "format": "uuid"
            },
            "style": "simple"
          }
        ],
        "responses": {
          "...": "..."
        }
      }
    },

The function is missing the parameters field completely

    "/todo/{id}/depends-on/{depends_on_id}": {
      "put": {
        "description": "Todo depends on another Todo.",
        "responses": {
          "...": "..."
        }
      }
    },
@tamasfe
Copy link
Owner

tamasfe commented Feb 13, 2024

As far as I remember I left this out intentionally as tuples don't contain name information for parameters and the schema generation is decoupled from the path itself.

That being said it could be possible to support this in some way during generation, we would have to parse the path to look for parameters and adjust the schemas accordingly, I'm not sure if it's worth the effort but I'm not against it if it's doable without a major bump in complexity.

@tamasfe tamasfe added the enhancement New feature or request label Feb 13, 2024
@tomas789
Copy link
Author

Understood. I'd suggest to at least change the current behaviour. At the moment it fails silently which is less than ideal. I've spent unreasonable amount of time chasing this one (it showed up on the client-side after code-generator which also had a related bug 🤦). Perhaps just fail the whole compilation with a way to override the failure?

@iftachFridental
Copy link

any update? having the same issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants