Maint/#217 #230
Maint/#217 #230
Conversation
| @@ -67,7 +67,7 @@ def indexed_fields(self) -> set[str]: | |||
| def create(self, url_prefix: str) -> APIRouter: | |||
| router = APIRouter() | |||
| read_class = resource_read(self.resource_class) # type: ignore | |||
| indexed_fields = Literal[tuple(self.indexed_fields)] # type: ignore | |||
| indexed_fields: TypeAlias = Literal[tuple(self.indexed_fields)] # type: ignore | |||
There was a problem hiding this comment.
This allows us to remove a # type: ignore for search_fields below. docs
There was a problem hiding this comment.
Thanks Pieter, looks great!
Out of curiosity: we normally don't fork the project. I personally find it easier to just switch to a different brand instead of checking out a fork, if I want to test out the PR. You probably created a fork because you didn't have the correct access rights yet, I guess? Or do you generally like it better to create a fork?
|
Anyway, feel free to merge it! |
|
Indeed, I forked because I did not have write access to the repository at the time. As long as people are mindful of their branches (i.e., enable auto-delete after merge, curate their own stale branches), then I also prefer working with branches in a repository over branches in forks. |
This specifically only annotates those endpoints which has a
PathorQueryin their signature.However, it may be useful to annotate all endpoint parameters this way, to explicitly state whether they are
Query,Path, orBodyparameters and provide them with additional metadata (description, example).