OpenAPIInstall

Summary

Execute an arbitrary HTTP operation defined in an OpenAPI specification by selecting the operation and providing required inputs such as path parameters, query parameters, and request body.

Inputs

• Content Type Name or ID — Select the request content type or specify it via expression, depending on the operation's supported request body types.
• Path Parameters — Provide values for URL path parameters required by the selected operation.
• Query Parameters — Provide values for query string parameters for the selected operation.
• JSON Input Mode — For JSON request bodies, choose to fill fields based on API schema or enter raw JSON directly.
• Request Body (Fields) — Fill in JSON fields based on the API schema when 'Use Schema Fields' mode is selected.
• Request Body (Raw JSON) — Enter raw JSON string for the request body when 'Raw JSON' mode is selected.
• Request Body (XML) — Enter a raw XML request body when content type is 'application/xml'.
• Form Data — Provide form fields for 'application/x-www-form-urlencoded' or 'multipart/form-data' request bodies.
• Binary Property — Specify the binary property name containing the file to upload when sending multipart form data.

Output shape

a list of JSON objects, each representing the parsed response body for the corresponding input item

The node makes the HTTP request defined by the selected OpenAPI operation, substituting path and query parameters and providing the request body as specified. It returns the response body JSON parsed. HTTP errors (status >= 400) cause the node to throw an error including the HTTP status and response body.

Links

• n8n community nodes installation guide