Skip to content
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

API v3: remove last_build expandable field #11730

Merged
merged 2 commits into from
Oct 31, 2024
Merged

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Oct 30, 2024

There is no data for this field in CF, so nobody is using it.

Closes https://github.com/readthedocs/readthedocs-corporate/issues/1874


📚 Documentation previews 📚

@stsewd stsewd requested review from a team as code owners October 30, 2024 19:29
@stsewd stsewd requested a review from ericholscher October 30, 2024 19:29
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we discussed removing all the expandable fields, unless we're using them? Woudl simplify the docs/code here, so might be worth doing.

cc @humitos

@humitos
Copy link
Member

humitos commented Oct 31, 2024

I'm fine removing expandable fields 👍🏼 . If we really need that data, we can always build regular API endpoint to return that data -- which has shown being a lot easier to maintain, in particular when related to permissions.

In the case of ?expand=active_version we already have ?active=true&built=true in the versions endpoint: https://readthedocs.org/api/v3/projects/test-builds/versions/?verbose_name=&privacy_level=&active=true&built=true&uploaded=&slug=&type=

We could add a new field in the _links if we want to have a direct URL to that filter.

@humitos
Copy link
Member

humitos commented Oct 31, 2024

@stsewd stsewd merged commit 072212b into main Oct 31, 2024
8 checks passed
@stsewd stsewd deleted the remove-last-build-exp-field branch October 31, 2024 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants