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

feat: add more rfc api fields (many stubs) #8492

Open
wants to merge 1 commit into
base: feat/rpc-api
Choose a base branch
from

Conversation

jennifer-richards
Copy link
Member

This adds the extra fields requested here. Many of these are empty stubs, and a couple have more structure than the mock implementation. This is intended as an incremental step to allow progress on the rfced-www client side, not a finished piece of the server-side API. I'm expecting there'll be some iteration (either in this PR or in later updates) on the format / data included in this API call.

The is_also field (here, always an empty list) uses the historic "bad" name that represents "is-in-a-subseries-document". That will need to be implemented and given a more appropriate name.

Some other pieces can't or shouldn't be implemented yet. The "keywords" and "see also" fields don't (afaik) exist in the datatracker yet, so there's no data to include. The "formats" field could probably be implemented, but it'd currently mean doing a whole lot of looking at the file system and will be changing with the blob store work.

I'm not sure how to represent "errata" at this point, or whether it's needed at the index level.

The draft field will probably need some optimization - I haven't profiled, but I suspect it's generating N+1 queries to look up the draft name/title. That can easily be fixed with some prefetching, but I'm holding off until we know what it really need to include in the response.

Generally speaking, I continue to worry a bit about providing an API call that potentially includes large amounts of data about large numbers of documents. If there are fields here that could be moved to the detail views instead of the index views (i.e., are only needed for a single RFC view, not for the search results / index page), that would be a good thing to keep in mind.

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.

1 participant