make get_reference public

[n2ygk]

Description

Makes schemas.openapi.get_reference public (remove the _) to complement making other methods public such as get_component_name()

[tomchristie]

It's not immediately obvious to me when this'd be useful to have as public API, since it only makes sense to use if you've got references outside of the standard '$ref': '#/components/schemas/{...} space.

Are you able to provide some kind of slimmed down example that'd require this as public API?

[n2ygk]

@tomchristie

Are you able to provide some kind of slimmed down example that'd require this as public API?

I'm extending get_schema() and so far have two remaining private API calls: _get_reference and _initialise_endpoints

https://github.com/django-json-api/django-rest-framework-json-api/blob/c1ceb7f42b98ee382c11372e72933a8fbdfe9691/rest_framework_json_api/schemas/openapi.py#L547-L559

[tomchristie]

Okay, so... making it public not because you want to override the behaviour in it, but rather, making it public because your implementation needs to call it? That makes sense I guess.

[n2ygk]

Yep. Maybe do the same for _initialise_endpoints? I just prefer not to have to rely on private APIs. I can submit a PR for that as well or add it to this one if you prefer.

…

On Thu, Sep 3, 2020 at 10:27 AM Tom Christie ***@***.***> wrote: Okay, so... making it public not because you want to override the behaviour in it, but rather, making it public because your implementation needs to call it? That makes sense I guess. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#7515 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABBHS57YPOZRPGWDKTD3YDLSD6RV7ANCNFSM4QUYPQVQ> .

[n2ygk]

@tomchristie should this be in milestone 3.13 and/or labeled schema generation?

[n2ygk]

@carltongibson perhaps you can review this and put it on Tom's queue for 3.13?

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[n2ygk]

This stalebot stuff makes me sad that I wasted effort on submitting PRs.

[tomchristie]

This seems reasonable enough, yes.