enhance : Search for the name of the property item in "Search for artifacts" API.
See original GitHub issueWhen multiple people are developing or using many APIs, it becomes difficult to find out when and where the API was defined just by searching the name. If I want to search for APIs that handle similar data, I can use the property name, label, description, and other items to search.
The search for artifacts api does not have a function to search for a property name, so if I want to search for a property name, I need to open all the APIs and check them.
Search for artifacts API Document
Please add the ability to search by item property name.
Register a jsonshema that contains the property "post-office-box”.
{
"$id": "https://example.com/address.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "An address similar to http://microformats.org/wiki/h-card",
"type": "object",
"properties": {
"post-office-box": {
"type": "string"
},
"extended-address": {
"type": "string"
},
"street-address": {
"type": "string"
},
"locality": {
"type": "string"
},
"region": {
"type": "string"
},
"postal-code": {
"type": "string"
},
"country-name": {
"type": "string"
}
},
"required": [
"locality",
"region",
"country-name"
],
"dependencies": {
"post-office-box": [
"street-address"
],
"extended-address": [
"street-address"
]
}
}
Searching for post-office-box does not return any results.
http://localhost:8080/api/search/artifacts?limit=10&order=asc&over=everything&search=post-office-box
api response
{"artifacts":[],"count":0}
Issue Analytics
- State:
- Created 3 years ago
- Comments:16 (11 by maintainers)
Top GitHub Comments
Content based search will make the adoption of this tool faster within large Org having thousands of schemas. Often teams do search first to understand what existing events having certain attributes/fields to identify the existing schemas before asking to create/update another events. Without content search this is very difficult.
Yes an indexing mechanism is required.Options I’ve seen in other tools : Batch indexing (cron expression can be configured by admin to run the batch to avoid making tool response slow all the time due to indexing). Ideal will be real time index update but not making compromise to other response(UI & API). Even some schema format is difficult to add in search but starting with Jsonschma and other few schemas (even latest version content) in search (text bases exact match to start with) will be huge uplift to start with.
It’s more than this, actually. The search-by-properties feature is not designed to search within the content of an artifact. Instead we have artifact meta-data called
properties
which (just likename
,description
, andlabels
) is information provided by the user when creating the artifact/version or after creation when updating. We don’t currently extract properties from the content itself.There is a community effort going on right now to add support for Elasticsearch:
https://github.com/Apicurio/apicurio-registry/pull/1461
This would provide more advanced search capabilities (including content-based search I assume). I think this issue would be solved by that effort.