-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
APIv3: include readthedocs_yaml_path in Project serializer
#12566
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
base: main
Are you sure you want to change the base?
Conversation
Return the `readthedocs_yaml_path` field in the Project serializer for APIv3 and allow setting it as well.
|
@copilot please write a simple test case for this PR to check that setting |
- [x] Add `readthedocs_yaml_path` field to `ProjectSerializer` (read) - [x] Add `readthedocs_yaml_path` field to `ProjectUpdateSerializerBase` (write) - [x] Add test case `test_partial_update_project_readthedocs_yaml_path` to verify setting and getting the field via API - [x] Keep the comment about YAML config file settings <!-- START COPILOT CODING AGENT TIPS --> --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey). --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: humitos <244656+humitos@users.noreply.github.com>
stsewd
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Documentation needs to be updated. We should also verify if validation is the same as one we do on the model and form.
|
I added the validation and update the docs. |
Return the
readthedocs_yaml_pathfield in the Project serializer for APIv3 and allow setting it as well.Requested by a user at https://app.frontapp.com/open/cnv_1i8d4tuq