Repository navigation
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1411.
Generated endpoint argument docstrings now prefer non-empty Parameter Object descriptions, falling back to schema descriptions when the parameter description is missing or empty. For example,
sincenow documents "Only include tasks changed after this timestamp" instead of only "Unix timestamp in milliseconds".The override applies to the endpoint property after schema parsing, so reusable model and field documentation keeps its schema descriptions. Component parameter references also retain their descriptions. Functional tests cover query, path, header and cookie parameters, schema fallback, references, shared model reuse, and all four sync/async endpoint functions.
Validation on Python 3.12:
pdm test_with_coverage: 473 passed, 100% coverage, all 5 snapshots passed.pdm run ruff check .,pdm run ruff format . --check, andpdm mypy --show-error-codes: passed.OPENAPI_PYTHON_CLIENT_FUZZ_EXAMPLES=100 pdm fuzz: 100 generated examples passed.The Docker-backed live integration tests were not run locally because a container runtime is unavailable.
AI assistance: OpenAI Codex was used for investigation, implementation, automated review, and validation.