Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ADD servicePath built in documentation #4380

Closed
wants to merge 1 commit into from
Closed

ADD servicePath built in documentation #4380

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/manuals/orion-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -674,6 +674,8 @@ the subscriptions based in alteration type features (see [Subscription based in
* `entityChange` if the update that triggers the notification was an update with an actual change or not an actual change but with `forcedUpdate` in use
* `entityDelete` if the update that triggers the notification was a entity delete operation

* `servicePath` (type: `Text`): specifies the service path associated to a given entity (See subsection [Service Path](#service-path) for more information)

Like regular attributes, they can be used in `q` filters and in `orderBy` (except `alterationType`).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chetan-NEC how servicePath behaves with q and orderBy? Could you add a couple of thest (one for q and other for orderBy) in PR #4329, please?

Depending on the result, we would add servicePath to the "except" list or not.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fgalan My understanding is that I must include test cases in PR #4329 for the servicePath with q and orderBy. Please confirm my understanding.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I confirm your understanding. Thanks!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fgalan In PR #4329, I've added test cases as you suggested. Please review the PR and let me know if you have any suggestions.

However, they cannot be used in resource URLs.

Expand Down