OAI / OAI/tools.openapis.org

Search refinements / API

Open
#58 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

to be included in another issue
Dominant language
JavaScript
Stars
177
Forks
87
Avg merge
1m
Merged PRs (30d)
1

Description

User Story

As a user, I want to quickly find quality and well supported tools that meet my needs and work in my environment. The current categories are broad and the lists contain too many items. I would like to reduce the number of matches using various filtering criteria.

Detailed Requirement

  • Add the following search criteria:
    • popularity (e.g. >= number of 'stars' , watchers, forks). Or possibly derive a popularity score based on multiple properties?
    • last update (e.g. past n-months)
    • supported version (check one or more)
    • operating environment / language
  • Understand this may be challenging to implement with 11ty. Indexing the tools.yaml file using an Apache Solr or Elastic Search server could provide a search API. Another option would be to implement a simple serverless microservice for search and retrieval (e.g. using node.js express)
  • Some of the criteria may not be currently supported by the model

note: suspect this is already on the roadmap....

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing tools.yaml and the existing 11ty search and retrieval flow. Compare the proposed Solr or Elasticsearch approach with a Node.js/Express service, checking which popularity, update, version, and environment fields the current model provides. Done means the search criteria and implementation direction are agreed and the API can filter the tool listings accordingly.

Written by the indexing model from the issue text.

Assessment

Tech stack
elasticsearch, express, javascript, node.js
Domain
api, search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.