Do not remove colon from url paths, verify they're not present in operation names

[eoma-knowit]

---

name: Pull request
title: 'Do not remove colon from url paths, verify they're not present in operation names'
labels: bugfix
assignees: christianhelle

---

Description:

Slight revert of #227. We should keep actual colons in url paths, but not in method names. Colons in urls are legal, and if a specification contains them, the generated interfaces should contain them.

Example OpenAPI Specifications:

swagger: '2.0'
info:
  title: Reference parameters
  version: v0.0.1
paths:
  '/orders/{orderId}/:orderItems/{orderItemId}':
    parameters:
      - $ref: '#/parameters/OrderId'
      - $ref: '#/parameters/OrderItemId'
    delete:
      summary: Delete an order item
      description: >-
        This method allows to remove an order item from an order, by specifying
        their ids.
      responses:
        '204':
          description: No Content.
parameters:
  OrderId:
    name: orderId
    in: path
    description: Identifier of the order.
    required: true
    type: string
    format: uuid
  OrderItemId:
    name: orderItemId
    in: path
    description: Identifier of the order item.
    required: true
    type: string
    format: uuid

Example generated Refit interface

public partial interface IReferenceparameters
    {
        /// <summary>Delete an order item</summary>
        /// <remarks>This method allows to remove an order item from an order, by specifying their ids.</remarks>
        /// <param name="orderId">Identifier of the order.</param>
        /// <param name="orderItemId">Identifier of the order item.</param>
        /// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>
        /// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>
        [Delete("/orders/{orderId}/:orderItems/{orderItemId}")]
        Task OrderItems(System.Guid orderId, System.Guid orderItemId);
    }

Summary by CodeRabbit

• Bug Fixes

  • Correct handling of colons in API paths: generated operation names no longer include colons, while path templates preserve colon-prefixed segments as defined.
  • Improves reliability when generating clients for APIs with colon-delimited routes.

• Tests

  • Updated test coverage to validate new colon handling in generated code, ensuring operation names and path literals meet expectations.

[coderabbitai]

Walkthrough

Simplifies OpenAPI document loading by removing path sanitization in RefitGenerator and directly returning the factory-created document. Updates a test to expect colon-containing path literals while ensuring operation names exclude colons.

Changes

Cohort / File(s)	Summary of changes
Generator control flow simplification src/Refitter.Core/RefitGenerator.cs	Removed path sanitization logic and helper; GetOpenApiDocument now directly awaits and returns OpenApiDocumentFactory.CreateAsync(settings.OpenApiPath). No public API changes.
Test expectation updates for colon handling src/Refitter.Tests/Examples/ColonsInPathTests.cs	Renamed test to focus on operation name; assertions changed to require colon preserved in path literal and disallowed in operation name.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant C as Caller
  participant RG as RefitGenerator
  participant ODF as OpenApiDocumentFactory

  Note over RG: New flow (simplified)
  C->>RG: GetOpenApiDocument(settings)
  RG->>ODF: CreateAsync(settings.OpenApiPath)
  ODF-->>RG: OpenApiDocument
  RG-->>C: OpenApiDocument

Loading

sequenceDiagram
  autonumber
  participant C as Caller
  participant RG as RefitGenerator
  participant ODF as OpenApiDocumentFactory

  rect rgba(240,240,255,0.6)
  Note over RG: Old flow (removed)
  C->>RG: GetOpenApiDocument(settings)
  RG->>RG: SanitizePath loop over special chars
  RG->>ODF: CreateAsync(modifiedPath)
  ODF-->>RG: OpenApiDocument
  RG-->>C: OpenApiDocument
  end

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A bunny taps the keys—so neat,

Snips the loops, makes code petite.

Colons stay where paths do roam,

But names keep tidy, squeaky, home.

Hop, compile, a lighter feat—

Thump-thump: one call, job complete. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title succinctly captures the core change of retaining literal colons in URL paths while ensuring they are removed from generated operation names, directly reflecting the modifications to path sanitization and naming logic. It is specific, clear, and concise, enabling reviewers to quickly understand the primary focus of the changeset.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 63014df and 923bb32.

📒 Files selected for processing (2)

• src/Refitter.Core/RefitGenerator.cs (1 hunks)
• src/Refitter.Tests/Examples/ColonsInPathTests.cs (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

src/**/*.cs

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

src/**/*.cs: Follow existing C# coding conventions defined in .editorconfig
Use PascalCase for public members
Use camelCase for parameters and local variables
Include XML documentation for public APIs
Use meaningful variable and method names

Files:

• src/Refitter.Core/RefitGenerator.cs
• src/Refitter.Tests/Examples/ColonsInPathTests.cs

src/Refitter.Tests/Examples/**/*.cs

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

All new code must include unit tests following the Refitter.Tests.Examples pattern

Files:

• src/Refitter.Tests/Examples/ColonsInPathTests.cs

🧠 Learnings (2)

📚 Learning: 2025-09-17T20:15:55.708Z

Learnt from: CR
PR: christianhelle/refitter#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-09-17T20:15:55.708Z
Learning: Applies to src/Refitter.Core/RefitInterfaceGenerator.cs : Implement generation logic for new options in src/Refitter.Core/RefitInterfaceGenerator.cs (or related generator classes)

Applied to files:

• src/Refitter.Core/RefitGenerator.cs

📚 Learning: 2025-09-17T20:15:55.708Z

Learnt from: CR
PR: christianhelle/refitter#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-09-17T20:15:55.708Z
Learning: Applies to src/Refitter.Tests/Examples/**/*.cs : All new code must include unit tests following the Refitter.Tests.Examples pattern

Applied to files:

• src/Refitter.Tests/Examples/ColonsInPathTests.cs

🧬 Code graph analysis (1)

src/Refitter.Core/RefitGenerator.cs (1)

src/Refitter.Core/OpenApiDocumentFactory.cs (1)

• OpenApiDocumentFactory (12-114)

🔇 Additional comments (2)

src/Refitter.Core/RefitGenerator.cs (1)

35-36: Preserving literal path segments looks good.

Returning the document straight from the factory keeps any literal characters (like colons) intact so downstream generators see the raw OpenAPI shape as intended.

src/Refitter.Tests/Examples/ColonsInPathTests.cs (1)

59-60: Great regression coverage for colon handling.

The paired assertions make sure we retain the literal route segment while keeping the generated method name clean—exactly the balance this fix targets.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[Copilot]

Pull Request Overview

This PR partially reverts changes from #227 to correctly handle colons in URL paths. The change ensures that colons remain in URL path templates (which is legal in HTTP paths) while still removing them from operation names (which could cause C# compilation issues).

• Removes the path sanitization logic that was stripping colons from OpenAPI document paths
• Updates test to verify colons are preserved in path templates but excluded from operation names

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
src/Refitter.Core/RefitGenerator.cs	Removes the SanitizePath method and related logic that was incorrectly removing colons from URL paths
src/Refitter.Tests/Examples/ColonsInPathTests.cs	Updates test to verify colons are preserved in path templates while ensuring operation names don't contain colons

[christianhelle]

@eoma-knowit thanks for taking the time to look into this and come up with a fix ❤️

[christianhelle]

@all-contributors please add @eoma-knowit for code

[allcontributors]

@christianhelle

I've put up a pull request to add @eoma-knowit! 🎉