Title: [API Request]: /api/search to return url to result · Issue #3080 · BookStackApp/BookStack · GitHub
Open Graph Title: [API Request]: /api/search to return url to result · Issue #3080 · BookStackApp/BookStack
X Title: [API Request]: /api/search to return url to result · Issue #3080 · BookStackApp/BookStack
Description: API Endpoint or Feature Thanks for adding /api/search endpoint :) One attribute that this endpoint doesn't return is a url which is directly linkable - it seems as an API consumer I need to do additional business logic/API calls to get a...
Open Graph Description: API Endpoint or Feature Thanks for adding /api/search endpoint :) One attribute that this endpoint doesn't return is a url which is directly linkable - it seems as an API consumer I need to do addi...
X Description: API Endpoint or Feature Thanks for adding /api/search endpoint :) One attribute that this endpoint doesn't return is a url which is directly linkable - it seems as an API consumer I need to do ...
Opengraph URL: https://github.com/BookStackApp/BookStack/issues/3080
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[API Request]: /api/search to return url to result","articleBody":"### API Endpoint or Feature\n\nThanks for adding `/api/search` endpoint :) One attribute that this endpoint doesn't return is a url which is directly linkable - it seems as an API consumer I need to do additional business logic/API calls to get a URL to be able to link to the result.\n\n### Use-Case\n\nI have an external system which displays related bookstack results by querying on a tag, I want to just display a list of search results in the external system and directly link to them using a single API call (and ideally not get into the internal details of bookstack pages/chapters/shelves etc)\r\n\r\ni.e.\r\n```\r\n $resp = $client->get(\"https://bookstack/api/search?query=[Tagname={$tagvalue}]\");\r\n $response = json_decode($resp->getBody());\r\n foreach ($response->data as $result) {\r\n $o.=\"\u003cli>\u003ca target='_blank' href='{$result->url}'>{$result->name}\u003c/a>\u003c/li>\\n\"; \r\n } \r\n```\n\n### Additional context\n\nI quickly hacked in this locally with the following patch - if this approach is valid, i'd be happy to update tests etc and prepare a pull request. \r\n```\r\ndiff --git a/app/Http/Controllers/Api/SearchApiController.php b/app/Http/Controllers/Api/SearchApiController.php\r\nindex ba960b9d..0a9d2df1 100644\r\n--- a/app/Http/Controllers/Api/SearchApiController.php\r\n+++ b/app/Http/Controllers/Api/SearchApiController.php\r\n@@ -52,9 +52,10 @@ class SearchApiController extends ApiController\r\n 'id', 'name', 'slug', 'book_id',\r\n 'chapter_id', 'draft', 'template',\r\n 'created_at', 'updated_at',\r\n- 'tags', 'type',\r\n+ 'tags', 'type', 'url',\r\n ]);\r\n $result->setAttribute('type', $result->getType());\r\n+ $result->setAttribute('url', $result->getURL());\r\n }\r\n \r\n return response()->json([\r\n```","author":{"url":"https://github.com/danpoltawski","@type":"Person","name":"danpoltawski"},"datePublished":"2021-11-26T07:12:34Z","url":"https://github.com/BookStackApp/BookStack/issues/3080"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:7c2c51cb-cdfd-5b04-4247-4f1a45c0cfa3 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 92E4:2ADB95:905ABA:CF2715:6AFD88F1 |
| html-safe-nonce | 8c707c233359bc307b9cb2b3fe8231f00e1293b03a57006fd82f8a8cc3dd7e94 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5MkU0OjJBREI5NTo5MDVBQkE6Q0YyNzE1OjZBRkQ4OEYxIiwidmlzaXRvcl9pZCI6IjE4NzEzMzcwNTI0NjE0MzUxMjEiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 88addf287a319cae495c47bae38c2aeb8cb78bf2ef16eee7dfb2f023ccc93b2c |
| hovercard-subject-tag | issue:1064166141 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/BookStackApp/BookStack/3080/issue_layout |
| twitter:image | https://opengraph.githubassets.com/ee7a03737a228c0f68ca6e187e62ba295c361edd9227dfe6181fa7ae9de71eb5/BookStackApp/BookStack/issues/3080 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/ee7a03737a228c0f68ca6e187e62ba295c361edd9227dfe6181fa7ae9de71eb5/BookStackApp/BookStack/issues/3080 |
| og:image:alt | API Endpoint or Feature Thanks for adding /api/search endpoint :) One attribute that this endpoint doesn't return is a url which is directly linkable - it seems as an API consumer I need to do addi... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | danpoltawski |
| hostname | github.com |
| expected-hostname | github.com |
| None | bc86424ef34a73b386237872800e922d149d65ba907f63d6f150a2dcb8433bea |
| turbo-cache-control | no-preview |
| go-import | github.com/BookStackApp/BookStack git https://github.com/BookStackApp/BookStack.git |
| octolytics-dimension-user_id | 20912696 |
| octolytics-dimension-user_login | BookStackApp |
| octolytics-dimension-repository_id | 41589337 |
| octolytics-dimension-repository_nwo | BookStackApp/BookStack |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 41589337 |
| octolytics-dimension-repository_network_root_nwo | BookStackApp/BookStack |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 927a6c5ab1c32b38830f1b9d3050c0b9e9aa92e1 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width