Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Liberu Search API

Authenticated, rate-limited HTTP endpoints for Search.

Software · Hosting · Services · Liberu Group

PHP Latest release License: MIT

Feature scope

Authenticated, rate-limited HTTP endpoints for Search. This repository owns this capability as an independently versioned Composer package; hosts integrate it through its declared public boundaries rather than application-specific classes.

Capabilities

  • foundation.search.api

Declared features

  • Authenticated
  • Rate-limited HTTP endpoints for Search

Requirements and installation

Dependency Supported version
php ^8.5
illuminate/http ^13.0
illuminate/routing ^13.0
liberusoftware/search ^1.0

Install the released package from the project root:

composer require liberusoftware/search-api

The trusted liberusoftware/composer-installer places it in /modules/search-api. The installed directory remains tracked by the host repository, while Composer and its lock file remain the source of version truth. Installation does not imply runtime enablement or commercial entitlement.

Architecture and integration

  • Composer package: liberusoftware/search-api
  • Package type: liberu-module
  • Installer name: search-api
  • Category: presentation
  • Service provider: Liberu\Foundation\SearchApi\SearchApiServiceProvider
  • Enabled by default: no

Public contracts

  • No separate contract type is declared; use the documented provider and capability boundary.

Commands

  • No console command is provided.

Events

  • No package-owned event class is currently published.

Persistence and permissions

  • This package owns no database migration.

Authorization remains the host application's responsibility unless a public authorizer contract is listed above. Consumers should grant only the permissions needed for the exported capabilities and must not couple to internal tables or classes.

Testing

The package includes 2 test file(s). From a compatible host checkout, run:

vendor/bin/pest modules/search-api/tests

Changes must preserve the manifest, service-provider integration, package boundaries, and PHP/Laravel compatibility declared above.

Security

Do not report security vulnerabilities through public GitHub issues. Email security@liberusoftware.com with reproduction details and the affected version so the report can be handled privately.

License

This module is open-source software available under the MIT License. The linked licence text is authoritative.

Feedback and contributing

Focused issues and tested pull requests are welcome in the GitHub repository. Keep changes within this module's capability boundary, update tests and documentation, and record user-visible changes in CHANGELOG.md.

Contributors

Thank you to everyone who helps improve Liberu. View the contributors graph.

About

Authenticated, rate-limited HTTP endpoints for Search.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages