Tagged “reference”

Technical reference for the Admin API, the control plane for managing services, WSDL imports, mappings, backends, and observability.

Manage API operations, including REST endpoints, schemas, and asynchronous behavior. This reference details methods for finding, updating, and

An overview of the SOAP-2-REST platform's Admin, Runtime, and Ingest APIs, covering their purpose, authentication, base paths, and error handling.

Manages the lifecycle of discovery ingest relay VMs. This service handles health checks, automatic recreation, image version reconciliation, and disk

A complete reference for all S2R-prefixed error codes returned by the Admin and Runtime APIs, including the standard JSON error envelope and area prefixes.

Explains how stored F5 BIG-IP instance records are mapped to connection settings for discovery services and log forwarding configurations.

Defines the data structure returned after generating a new API service. Includes service and version IDs, configuration details, and any contract warnings.

Describes the license heartbeat client, which sends periodic telemetry to the Specaria platform. Details the payload, configuration, and operational

Technical documentation for the Update Channel Service, which manages software update status, channels, and operator-approved updates via a release

Describes the aggregation process that collapses fine-grained traffic data into canonical service definitions for Master Discovery.

API endpoints for detailed analysis of aggregated service discovery data, including traffic timelines, consumers, failures, and alert configuration.

Describes the automated service that periodically refreshes the master discovery table from observed traffic for F5 and generic API gateways.

Describes how the platform stores, retrieves, and updates OpenAPI specification artifacts for service versions, detailing the underlying data models and

Technical reference for the OpenApiService, which generates and stores OpenAPI 3.0 specifications for PUBLISH services based on WSDL and platform

Describes the automated quality analysis service that lints OpenAPI specifications for issues like missing descriptions, naming drift, and invalid

Technical reference for the Runtime API, the live data plane for request/response conversion. Details on publish (REST-to-SOAP) and consume (SOAP-to-REST)

Explains how the Version Repository manages the lifecycle of API service versions, including creation, activation, rollback, and route publishing.

Describes how the platform identifies SOAP services by parsing the namespace and local name of the first element in the SOAP Body or the root of a bare

Technical reference for the SOAP Message Mapper, which transforms JSON to SOAP and SOAP to JSON, with extensive data conversion and WS-Security options.

Resolves a canonical service URI for SOAP traffic when the request URL is generic, like '/'. Uses the SOAPAction header or SOAP body to attribute traffic.

Diagnose and regenerate SOAP-to-REST operation mappings. This service provides tools to assess mapping readiness and bulk-update them after WSDL changes.

Proxies test execution requests to the runtime environment. Mints a short-lived JWT for authentication and records successful runs for readiness checks.

Explains the WSDL import round-trip validator, which checks generated examples against their own constraints to prevent runtime validation failures.

Explains the S2R-ADM-0612 error, which occurs when a WSDL's example values fail validation against their own XSD constraints during import.

Import, repair, and manage WSDL documents via API. Use file uploads, URLs, or raw XML to create service drafts and automate SOAP API onboarding.

Explains how the platform generates import previews for WSDLs, including REST route suggestions, example SOAP/JSON payloads, and complexity analysis.

Explains how the WSDL parser processes WSDL and XSD documents, resolves external references, suggests backend configurations, and handles various SOAP

Describes the data model for the result of a WSDL replacement draft operation. Includes service/version IDs, operation counts, and contract warnings.

Explains how to generate new API services and replacement drafts from imported WSDL artifacts, including automatic configuration and validation.