Field definitions after pressing "option" button in API UI?

[noahblakesmith]

In the API UI, I recall having the ability to see field definitions when I press the "option" button. However, I no longer see them.

For example, @mlissner posted a screenshot last year, which depicts the role definitions for the attorney API.

Have field definitions been moved elsewhere?

Thank you!

[mlissner]

We haven't done anything to change that. It's possible you can't see the button when you're not logged in?

[noahblakesmith]

@mlissner I just pressed the "option" button while logged in. However, I still don't see any definitions. I am attaching a PDF. Am I missing something?

attorneys_api_ui_option_results.pdf

[mlissner]

Huh, yeah, I can't find the role definition in either the v3 or v4.1 API when doing an OPTIONS request.

@ERosendo, my first guess was that this was due to a feature in v4.1, but since it affects v3 too, that seems unlikely. I think we might have upgraded DRF or Django-filters recently. Is it possible that might have done it? Can you investigate please and maybe ask around if anybody else has any ideas?

[ERosendo]

Hi @mlissner, It looks like your initial hunch was correct. The definitions changed after a modification I made in #4729 (introduced logic to filter nested results). This change is also impacting v3 because I updated the serializer to accommodate both our custom filtering logic and the previous schema.

DRF documentation has a relevant section on addressing this issue: https://www.django-rest-framework.org/api-guide/schemas/#map_field

I'll open an issue to address this.

[mlissner]

Sorry about that, @noahblakesmith. If you need these definitions, the other way to get them is from the models directly, for example, here: https://github.com/freelawproject/courtlistener/blob/main/cl/people_db/models.py#L1434