API Browser Omeka S module

Releases

1.0.2

Oct 20, 2026

  • Editors and other roles below Supervisor who open the Public visibility settings page (/admin/api-browser/settings) now get Omeka's Forbidden page with HTTP status 403. They used to get Omeka's error page Omeka S encountered an error with status 500. Who may use the browser and its settings is unchanged.
  • The browser's request, schema and sample endpoints answer JSON on a site where no other module registers Laminas' JSON view strategy (Omeka core doesn't); the module now registers it.

1.0.1

Oct 20, 2026

  • The Auth panel of the public browser said "Session (current user)", although its requests go to /api without a key and so always run as an anonymous visitor. It now says "None (public, read-only)".
  • Optional factory arguments are declared explicitly nullable, which removes PHP 8.4 deprecation notices.

1.0.0

Sep 22, 2026

Initial release.

  • Discovers every registered Omeka S API adapter, from core and from installed modules, and lists it with the operations the current user is allowed to perform.
  • Per-resource reference built from Doctrine entity metadata, a curated catalog of JSON-LD keys and query parameters for core resources, and the adapter's hydrator methods.
  • Send API Request panel that runs search, read, create, update, partial update and delete calls through Omeka's API manager as the logged-in user, with status, timing and the JSON response.
  • Ready-to-copy request examples in cURL, JavaScript, PHP and Python, with the selected API key filled in.
  • OpenAPI 3.1 export as JSON or YAML, generated from the discovered endpoints and schemas.
  • Optional public browser at /api-browser with a read-only OpenAPI spec, limited to the resources chosen on the Public visibility page.
  • Modules can extend the documentation of their own adapters by implementing an apiBrowserSchema() method.
Log in for Support