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

[BUG] Generator strips dollar signs in request query parameters #791

Open
calebdeji opened this issue Jan 30, 2025 · 0 comments
Open

[BUG] Generator strips dollar signs in request query parameters #791

calebdeji opened this issue Jan 30, 2025 · 0 comments
Assignees
Labels
bug Something isn't working Triage needed

Comments

@calebdeji
Copy link

The generated code for query parameters with dollar ($) doesn't match the initial value.

To Reproduce

  /sub-categories:
    get:
      tags: [Sub-categories]
      summary: List sub-categories
      security:
        - bearerAuth: []
      parameters:
        - name: 'filters[category][id][$eq]'
          in: query
          schema: { type: integer, example: 20 }
          description: Filter by category ID
        - name: 'filters[title][$containsi]'
          in: query
          schema: { type: string, example: 'account' }
          description: Filter by sub-category title
        - name: populate
          in: query
          schema: { type: string, enum: [category] }
          description: Include related category data
        - name: pagination[page]
          in: query
          schema: { type: integer, example: 1 }
          description: Page number
        - name: pagination[pageSize]
          in: query
          schema: { type: integer, example: 25 }
          description: Page size
///List sub-categories
  ///@param filters[category][id][$eq] Filter by category ID
  ///@param filters[title][$containsi] Filter by sub-category title
  ///@param populate Include related category data
  ///@param pagination[page] Page number
  ///@param pagination[pageSize] Page size
  Future<chopper.Response<SubCategoryListResponse>> subCategoriesGet({
    int? filtersCategoryId$eq,
    String? filtersTitle$containsi,
    enums.SubCategoriesGetPopulate? populate,
    int? paginationPage,
    int? paginationPageSize,
  }) {
    generatedMapping.putIfAbsent(SubCategoryListResponse, () => SubCategoryListResponse.fromJsonFactory);

    return _subCategoriesGet(
        filtersCategoryId$eq: filtersCategoryId$eq,
        filtersTitle$containsi: filtersTitle$containsi,
        populate: populate?.value?.toString(),
        paginationPage: paginationPage,
        paginationPageSize: paginationPageSize);
  }

  ///List sub-categories
  ///@param filters[category][id][$eq] Filter by category ID
  ///@param filters[title][$containsi] Filter by sub-category title
  ///@param populate Include related category data
  ///@param pagination[page] Page number
  ///@param pagination[pageSize] Page size
  @Get(path: '/sub-categories')
  Future<chopper.Response<SubCategoryListResponse>> _subCategoriesGet({
    @Query('filters[category][id][eq]') int? filtersCategoryId$eq,
    @Query('filters[title][containsi]') String? filtersTitle$containsi,
    @Query('populate') String? populate,
    @Query('pagination[page]') int? paginationPage,
    @Query('pagination[pageSize]') int? paginationPageSize,
  });

The @Query annotations' values don't include the dollar sign.

Library version used:
^3.0.1

@calebdeji calebdeji added bug Something isn't working Triage needed labels Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working Triage needed
Projects
None yet
Development

No branches or pull requests

3 participants