swagger-typescript-api icon indicating copy to clipboard operation
swagger-typescript-api copied to clipboard

feat: add sort-route-params flags

Open remigermain opened this issue 1 month ago • 1 comments

feat:

  • add --sort-route-params flags

Before, the order of an API’s parameters was defined by the order specified in the Swagger definition, which could be counter‑intuitive. For example:

JournalArticleCreate(
  articleId: number,
  journalId: string,
  data: PatchedImageRequest,
  params: RequestParams = {}
) =>
  this.request<Image, any>({
    path: `/v1/journal/${journalId}/article/${articleId}/`,
    method: "PATCH",
    body: data,
    secure: true,
    type: ContentType.FormData,
    format: "json",
    ...params,
  })

As you can see, you have to pass articleId first and then journalId, which isn’t really intuitive. This pull request adds the flag --sort-route-params to reorder the parameters so that they follow the order in the URL. By default, it doesn’t change the current behavior, but when the flag is used, the result will be:

JournalArticleCreate(
  journalId: string,
  articleId: number,
  data: PatchedImageRequest,
  params: RequestParams = {}
) =>
  this.request<Image, any>({
    path: `/v1/journal/${journalId}/article/${articleId}/`,
    method: "PATCH",
    body: data,
    secure: true,
    type: ContentType.FormData,
    format: "json",
    ...params,
  })

remigermain avatar Oct 28 '25 21:10 remigermain

⚠️ No Changeset found

Latest commit: 246f1561d094b344a82e83d7bae70f5e397430f3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar Oct 28 '25 21:10 changeset-bot[bot]