Hi
The newly published TMF630 guidelines include a whole new chapter on using JSON Path for filtering, this could perhaps answer your needs using the standard GET API. Suggest you take a look.
If you have very specific needs, you could consider using the Task Resource pattern, also described in TMF630.
TMF630 can be found
here.
Hope it helps.
------------------------------
Jonathan Goldberg
Amdocs Management Limited
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
------------------------------
Original Message:
Sent: Jul 16, 2020 09:30
From: jonathan schoreels
Subject: Extra Custom Search Operations in TMF OpenAPIS
Hi,
My team is currently implementing our new Webservices following the TMF OpenAPIs. While we have found most of our use case in OpenAPIs, we still often need a "search" operation on top of the existing CRUD operations.
Do you have any pointers on TMForum OpenAPIs that implements those search operations ?
What's your thoughts on using the already defined "GET" operations and use URL Path Parameters to search for entities ? For examples/api/service?category=X ? As it could lead to long URL for specific search, we could also try to use a more "RPC-ish" way to deal with those services and do a "POST /api/service/_search" with the criteria in the payload
Of course, all of those customisation would lead to modify the OpenAPI ... But since we would implements as expected the "official operations", I think we can consider we would still be TMF OpenAPI compliant ?
Kudos,
------------------------------
jonathan schoreels
VOO SA
------------------------------