v1

latestOpenAPI 3.0.32026-07-17465.6 KB

services

Generate request

Generate a valid request for a specific operation within a service. Returns the generated path, headers, body, and content type.

post/.services/{serviceName}

Path parameters

serviceNamestring required

Example:petstore

Service name. Use .root for root-level services.

Request body

pathstring

The path pattern to generate a request for

methodstring

HTTP method

contextobject

Custom context values for placeholder replacement

Example request

{
  "path": "/pet/{petId}",
  "method": "GET",
  "context": {
    "petId": 123,
    "name": "Fluffy"
  }
}

Response

Successful response

pathstring

Generated path with placeholders replaced

contentTypestring

Request content type (for POST/PUT/PATCH)

headersobject

Generated request headers

{"stackTrail":"components:schemas:GenerateResponse:properties:body","oasType":"schema","type":"unknown","description":"Generated request body (structure depends on the operation)"}

Example response

{
  "path": "/pet/123",
  "contentType": "application/json"
}