Skip to content
agovena.
agovena.
Get started
Community

API overview

Read the OpenAPI document

Choose an operation to see its request, response shape, access rules and implementation source.

ReadPublic

GET/api/v1/openapi.json

Read the OpenAPI document

No auth:sanctum or bearer ability is required by this route.

Request

No parameters or request body.

cURL
curl --request GET "https://shop.example.test/api/v1/openapi.json" \
  --header 'Accept: application/json'
Response200
Success: 200

Response shape (notation, not a captured response)

schema
{ openapi: "3.0.3", info, servers, tags, components, paths }

Full response schema

Common errors

No route-specific business errors are declared. Global middleware and server failures still apply.

Search documentation

Search guides, commands and API endpoints

What are you looking for?

Documentation