Skip to content

Commit

Permalink
API doc: Clarify the usage of recommededMerge
Browse files Browse the repository at this point in the history
- Disambiguate between a passive lack of application (still pending)
  and actively dismissing the recommendation.
- Specify how to get pending recommendations.

Signed-off-by: Igor Zubiaurre <izubiaurre@bitergia.com>
  • Loading branch information
fioddor committed Apr 19, 2024
1 parent 1598cbe commit 572130c
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion sortinghat/core/schema.py
Expand Up @@ -1616,7 +1616,13 @@ class SortingHatQuery:
page_size=graphene.Int(),
page=graphene.Int(),
filters=RecommendationFilterType(required=False),
description='Get all recommended matched identities.'
description=(
'Get all identities merge recommendations.'
''
'Call without filters to get all the pending recommendations.'
'Use the `isApplied` filter with `true` to get applied recommendations'
'or with `false` to get dismissed ones.'
)
)
recommended_gender = graphene.Field(
RecommendedGenderPaginatedType,
Expand Down

0 comments on commit 572130c

Please sign in to comment.