[ 
https://issues.apache.org/jira/browse/UNOMI-814?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18095511#comment-18095511
 ] 

Serge Huber commented on UNOMI-814:
-----------------------------------

h2. Re-targeted to unomi-3.2.0

Moved fixVersion from {{unomi-3.1.0}} to {{unomi-3.2.0}}.

OpenAPI/Swagger parameter descriptions still say {{profileId}} without noting 
that *aliases* are accepted on several profile routes. The *API behaviour* is 
correct on {{master}} ({{ProfileService.load}} resolves {{ProfileAlias}}). This 
is documentation/OpenAPI metadata only — not a 3.1.0 release blocker.

h2. Workaround for 3.1

Refer to the manual section on profile aliases. Use alias values in the same 
path parameters documented as {{profileId}}; runtime accepts them today.

> Swagger documentation doesn't take alias into account
> -----------------------------------------------------
>
>                 Key: UNOMI-814
>                 URL: https://issues.apache.org/jira/browse/UNOMI-814
>             Project: Apache Unomi
>          Issue Type: Bug
>    Affects Versions: unomi-2.4.0
>            Reporter: Romain Gauthier
>            Priority: Minor
>             Fix For: unomi-3.2.0
>
>         Attachments: screenshot-1.png, screenshot-2.png
>
>
> Aliases have been introduced in unomi 2.x but the swagger API documentation 
> doesn't reflect that. For instance, the endpoint "/profiles/\{profileId}" can 
> take aliases instead of profile ids.
> !screenshot-1.png|width=639,height=108!
> This is documented here 
> [https://unomi.apache.org/manual/latest/index.html#_what_profile_aliases_are_and_how_to_use_them]
> !screenshot-2.png|width=605,height=171! 
> but swagger should be updated everywhere endpoints can take profile or 
> aliases into account.
> Also, new tickets should be created if there are other endpoints that need to 
> be updated to add support for alias



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to