Back to the OpenAPI page

INFINITODE / API REFERENCE

Helix PSA

Loading API details from the specification…

Loading parameters…

Data from ./openapi.yaml. This page does not send requests to live API endpoints.

Loading the reference…

01 / ROUTES & METHODS

Endpoints.

Routes declared by the specification, with their methods and summaries.

02 / WHAT GOES IN

Parameters.

A summary of the input fields listed by your existing OpenAPI loader.

Parameter Location Type

See the YAML for required fields, authentication schemes, nested schemas and additional constraints.

03 / WHAT COMES BACK

Outputs.

The successful JSON properties listed by the existing loader. The YAML remains the complete reference.

Property Type
KEEP THE SCHEMA CLOSE
  1. Build the request.

    Use the parameter locations and authentication described by the specification.

  2. Check the details.

    Required inputs, constraints and alternative response statuses are defined in the YAML.

  3. Handle the response.

    Use the declared data types when processing successful results.

Response type map

Type labels from the 200 JSON schema—not example values or a live response.

{}
READ THE TYPES. REFER TO THE SCHEMA.