René's URL Explorer Experiment


Title: Endpoints with hyphens in parameter names trigger `Incorrect path templating` warning, are not generated · Issue #976 · openapi-generators/openapi-python-client · GitHub

Open Graph Title: Endpoints with hyphens in parameter names trigger `Incorrect path templating` warning, are not generated · Issue #976 · openapi-generators/openapi-python-client

X Title: Endpoints with hyphens in parameter names trigger `Incorrect path templating` warning, are not generated · Issue #976 · openapi-generators/openapi-python-client

Description: Describe the bug openapi-python-client fails to generate endpoints and throws incorrect path templating warnings when the path has a parameter with a hyphen. Renaming the parameters fixes the issue. Hyphens in parameter names don't seem ...

Open Graph Description: Describe the bug openapi-python-client fails to generate endpoints and throws incorrect path templating warnings when the path has a parameter with a hyphen. Renaming the parameters fixes the issue...

X Description: Describe the bug openapi-python-client fails to generate endpoints and throws incorrect path templating warnings when the path has a parameter with a hyphen. Renaming the parameters fixes the issue...

Opengraph URL: https://github.com/openapi-generators/openapi-python-client/issues/976

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Endpoints with hyphens in parameter names trigger `Incorrect path templating` warning, are not generated","articleBody":"**Describe the bug**\r\n\r\n`openapi-python-client` fails to generate endpoints and throws `incorrect path templating` warnings when the path has a parameter with a hyphen.\r\n\r\nRenaming the parameters fixes the issue. Hyphens in parameter names don't seem to go against Swagger/OpenAPI naming conventions, which would indicate that the issue is with `openapi-python-client`, though I haven't found any existing issues around this.\r\n\r\n**OpenAPI Spec File**\r\n\r\nThis is from an OpenAPI spec generated from [a Swagger spec](https://codeberg.org/swagger.v1.json) with [swagger-converter](https://github.com/swagger-api/swagger-converter). \r\n\r\n```\r\n  \"paths\": {\r\n    \"/activitypub/user-id/{user-id}\":\r\n      \"get\": {\r\n        \"parameters\": [\r\n          {\r\n            \"name\": \"user-id\",\r\n            ...\r\n          }\r\n        ],\r\n        ...\r\n      }\r\n    },\r\n    \"/activitypub/user-id/{user-id}/inbox\": {\r\n      \"post\": {\r\n        \"parameters\": [\r\n          {\r\n            \"name\": \"user-id\",\r\n            ...\r\n          }\r\n        ],\r\n        ...\r\n      }\r\n    },\r\n  ...\r\n  }\r\n```\r\n\r\n**Desktop (please complete the following information):**\r\n - OS: Linux Manjaro\r\n - Python Version: 3.12.2\r\n - openapi-python-client version: 0.17.3\r\n\r\n**Additional context**\r\n\r\nWarnings:\r\n\r\n```\r\nWARNING parsing GET /activitypub/user-id/{user-id} within activitypub. Endpoint will not be generated.\r\nIncorrect path templating for /activitypub/user-id/{user-id} (Path parameters do not match with path)\r\n\r\nWARNING parsing POST /activitypub/user-id/{user-id}/inbox within activitypub. Endpoint will not be generated.\r\nIncorrect path templating for /activitypub/user-id/{user-id}/inbox (Path parameters do not match with path)\r\n```\r\n\r\nTo diagnose, I added the following print statements to `parser/openapi.py`:\r\n\r\n```python\r\n    def sort_parameters(*, endpoint: \"Endpoint\") -\u003e Union[\"Endpoint\", ParseError]:\r\n        # ...\r\n        print(endpoint.name, endpoint.path)                                                   # \u003c- new\r\n        print(f'\\tparameters_from_path: {parameters_from_path}')                              # \u003c- new\r\n        print(f'\\tendpoint {endpoint.name}.path_parameters: {endpoint.path_parameters}')      # \u003c- new\r\n\r\n        if parameters_from_path != [param.name for param in endpoint.path_parameters]:\r\n            return ParseError(\r\n                detail=f\"Incorrect path templating for {endpoint.path} (Path parameters do not match with path)\",\r\n            )\r\n        return endpoint\r\n```\r\n\r\nFor comparison, replacing one of the `user-id` occurrences with `userid` and generating a client yields this:\r\n\r\n```\r\n('activitypubPerson /activitypub/user-id/{userid}'\r\n \"      parameters_from_path: ['userid']\"\r\n \"      endpoint activitypubPerson.path_parameters: [IntProperty(name='userid', \"\r\n \"required=True, default=None, python_name='userid', description=None, \"\r\n 'example=None)]'\r\n 'activitypubPersonInbox /activitypub/user-id/{user-id}/inbox'\r\n '      parameters_from_path: []'\r\n '      endpoint activitypubPersonInbox.path_parameters: '\r\n \"[IntProperty(name='user-id', required=True, default=None, \"\r\n \"python_name='user_id', description=None, example=None)]\"\r\n ...\r\n)\r\n```","author":{"url":"https://github.com/harabat","@type":"Person","name":"harabat"},"datePublished":"2024-02-22T16:54:22.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/976/openapi-python-client/issues/976"}

route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:06f87723-32bd-b3f9-5e44-54fc7dd6f741
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id8D12:339712:AFEB25:E431CA:697F85D0
html-safe-nonce4bc11cfbd4db30ef699a3781856412633aa4b26f2345bed1008c314372c11d76
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4RDEyOjMzOTcxMjpBRkVCMjU6RTQzMUNBOjY5N0Y4NUQwIiwidmlzaXRvcl9pZCI6IjY5MTI4OTgwNTgyMzM1NDYxOTIiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac413ddbeeb37ea5e756965a537195c5b7e67321937f4d73b34cc3d3fc40fc9c5a
hovercard-subject-tagissue:2149505619
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/openapi-generators/openapi-python-client/976/issue_layout
twitter:imagehttps://opengraph.githubassets.com/986282af78a4108d1cbfc07a0a5e6c347e81ef0512fe31b39379ff7228b86c87/openapi-generators/openapi-python-client/issues/976
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/986282af78a4108d1cbfc07a0a5e6c347e81ef0512fe31b39379ff7228b86c87/openapi-generators/openapi-python-client/issues/976
og:image:altDescribe the bug openapi-python-client fails to generate endpoints and throws incorrect path templating warnings when the path has a parameter with a hyphen. Renaming the parameters fixes the issue...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameharabat
hostnamegithub.com
expected-hostnamegithub.com
None60279d4097367e16897439d16d6bbe4180663db828c666eeed2656988ffe59f6
turbo-cache-controlno-preview
go-importgithub.com/openapi-generators/openapi-python-client git https://github.com/openapi-generators/openapi-python-client.git
octolytics-dimension-user_id84925606
octolytics-dimension-user_loginopenapi-generators
octolytics-dimension-repository_id240776275
octolytics-dimension-repository_nwoopenapi-generators/openapi-python-client
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id240776275
octolytics-dimension-repository_network_root_nwoopenapi-generators/openapi-python-client
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release7c85641c598ad130c74f7bcc27f58575cac69551
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/openapi-generators/openapi-python-client/issues/976#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenapi-generators%2Fopenapi-python-client%2Fissues%2F976
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub SparkBuild and deploy intelligent appshttps://github.com/features/spark
GitHub ModelsManage and compare promptshttps://github.com/features/models
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
GitHub SponsorsFund open source developershttps://github.com/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/accelerator
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://github.com/security/advanced-security
Copilot for BusinessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenapi-generators%2Fopenapi-python-client%2Fissues%2F976
Sign up https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=openapi-generators%2Fopenapi-python-client
Reloadhttps://github.com/openapi-generators/openapi-python-client/issues/976
Reloadhttps://github.com/openapi-generators/openapi-python-client/issues/976
Reloadhttps://github.com/openapi-generators/openapi-python-client/issues/976
openapi-generators https://github.com/openapi-generators
openapi-python-clienthttps://github.com/openapi-generators/openapi-python-client
Please reload this pagehttps://github.com/openapi-generators/openapi-python-client/issues/976
Notifications https://github.com/login?return_to=%2Fopenapi-generators%2Fopenapi-python-client
Fork 264 https://github.com/login?return_to=%2Fopenapi-generators%2Fopenapi-python-client
Star 1.9k https://github.com/login?return_to=%2Fopenapi-generators%2Fopenapi-python-client
Code https://github.com/openapi-generators/openapi-python-client
Issues 77 https://github.com/openapi-generators/openapi-python-client/issues
Pull requests 13 https://github.com/openapi-generators/openapi-python-client/pulls
Discussions https://github.com/openapi-generators/openapi-python-client/discussions
Actions https://github.com/openapi-generators/openapi-python-client/actions
Security 2 https://github.com/openapi-generators/openapi-python-client/security
Insights https://github.com/openapi-generators/openapi-python-client/pulse
Code https://github.com/openapi-generators/openapi-python-client
Issues https://github.com/openapi-generators/openapi-python-client/issues
Pull requests https://github.com/openapi-generators/openapi-python-client/pulls
Discussions https://github.com/openapi-generators/openapi-python-client/discussions
Actions https://github.com/openapi-generators/openapi-python-client/actions
Security https://github.com/openapi-generators/openapi-python-client/security
Insights https://github.com/openapi-generators/openapi-python-client/pulse
New issuehttps://github.com/login?return_to=https://github.com/openapi-generators/openapi-python-client/issues/976
New issuehttps://github.com/login?return_to=https://github.com/openapi-generators/openapi-python-client/issues/976
#986https://github.com/openapi-generators/openapi-python-client/pull/986
Endpoints with hyphens in parameter names trigger Incorrect path templating warning, are not generatedhttps://github.com/openapi-generators/openapi-python-client/issues/976#top
#986https://github.com/openapi-generators/openapi-python-client/pull/986
https://github.com/harabat
https://github.com/harabat
harabathttps://github.com/harabat
on Feb 22, 2024https://github.com/openapi-generators/openapi-python-client/issues/976#issue-2149505619
a Swagger spechttps://codeberg.org/swagger.v1.json
swagger-converterhttps://github.com/swagger-api/swagger-converter
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.