{"id":26690290,"url":"https://github.com/kaizenplatform/doc-search-api","last_synced_at":"2025-03-26T15:27:11.041Z","repository":{"id":28242226,"uuid":"31747645","full_name":"kaizenplatform/doc-search-api","owner":"kaizenplatform","description":"⚠️⚠️⚠️ DEPRECATED","archived":false,"fork":false,"pushed_at":"2015-09-09T01:49:54.000Z","size":177,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":39,"default_branch":"master","last_synced_at":"2024-04-15T00:50:27.562Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://ja.ngs.io/2015/03/07/private-middleman-search/","language":"CoffeeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kaizenplatform.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-06T02:07:18.000Z","updated_at":"2018-02-27T02:08:47.000Z","dependencies_parsed_at":"2022-09-04T17:01:22.333Z","dependency_job_id":null,"html_url":"https://github.com/kaizenplatform/doc-search-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaizenplatform%2Fdoc-search-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaizenplatform%2Fdoc-search-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaizenplatform%2Fdoc-search-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaizenplatform%2Fdoc-search-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kaizenplatform","download_url":"https://codeload.github.com/kaizenplatform/doc-search-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245680157,"owners_count":20654976,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-26T15:27:10.397Z","updated_at":"2025-03-26T15:27:11.036Z","avatar_url":"https://github.com/kaizenplatform.png","language":"CoffeeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# doc-search-api\n\nWeb API to Search Documentations from Middleman Site\n\n[![Circle CI](https://circleci.com/gh/kaizenplatform/doc-search-api/tree/master.svg?style=svg\u0026circle-token=26b2fc49c822c2255a676138f6defae6d30c467c)](https://circleci.com/gh/kaizenplatform/doc-search-api/tree/master)\n\n[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)\n\n## Requirements\n\n- Redis\n- node\n\n## Configuration\n\n- `TOKEN_SECRET`\n- `NODE_ENV`\n- `SITEMAP_URL`\n\n## Testing\n\n```bash\nnpm test\n```\n\n## Start server\n\n```\nnpm start\n```\n\n## Endpoints\n\n### Search\n\n```\nGET /?q=...\u0026lang=ja\n```\n\n### Trigger rebuild index\n\n```\nPOST /rebuild -d 'token=...\u0026timestamp=...'\n```\n\n## Example\n\n### Triggering rebuild from Rake task\n\n```rb\ndesc 'Request rebuilding search index'\ntask :rebuild_sitemap =\u003e [:env] do\n  if api_base = ENV['DOC_SEARCH_API_BASE']\n    require 'digest/sha1'\n    require 'json'\n    secret = ENV['REBUILD_TOKEN_SECRET']\n    ts = (Time.now.to_f * 1000).to_i.to_s\n    token = Digest::SHA1.hexdigest ts + secret\n    res = %x{curl -XPOST #{api_base}/rebuild -d 'token=#{token}\u0026timestamp=#{ts}'}\n    json = JSON.parse res\n    raise json['message'] if json['message']\n  end\nend\n```\n\nAuthor\n------\n\n[Atsushi Nagase]\n\nLicense\n-------\n\n[MIT License]\n\n[Atsushi Nagase]: http://ngs.io/\n[MIT License]: LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaizenplatform%2Fdoc-search-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkaizenplatform%2Fdoc-search-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaizenplatform%2Fdoc-search-api/lists"}