Releases

First version for Omeka Classic, the counterpart of ApiBrowser 1.0 for Omeka S.

• Every resource of the REST API, from Omeka and from plugins (the api_resources filter), in the admin at API Browser: their operations (those your role can use), query parameters with what they do, the keys of their JSON with an example from a real record, and the status codes to expect.
• Send API Request runs requests in Omeka as the signed-in user, the way the API does (it only accepts keys): the same record adapters, permissions, parameter checks, paging, Omeka-Total-Results and Link headers and error messages. Creates start from a record of the site. Protected by the session's CSRF token.
• Code samples in cURL, JavaScript, PHP and Python, with key=YOUR_API_KEY and a link to the user's API Keys page.
• OpenAPI 3.1 in JSON and YAML at /admin/api-browser/openapi.json|yaml, with the key query parameter (optional for reads), headers, examples, and the multipart upload of files.
• Public browser at /api-browser, with its own OpenAPI file: the resources chosen by Super Users and Admins, read only, examples from public records only, and requests sent to /api as a visitor. None chosen, or the REST API off: no public browser.
• Plugins can describe their resources' keys, query parameters and body fields with an apiBrowserSchema() method on their record adapter.
• Works in the admin and in any public theme, from phones to wide screens.