openapi: 3.2.0
info:
version: 1.0.0
title: OneRail Operation Dashboard Bulk Send SLA Template API
description: Defines Operations Dashboard APIs
license:
name: UNLICENSED
url: ''
servers:
- url: /
description: Default relative server URL
security:
- bearer: []
tags:
- name: Bulk Send SLA Template
paths:
/v1/shipper-contract-sla-template/bulk-send-templates:
post:
x-exegesis-controller: ShipperContractSlaTemplate
summary: Send Bulk SLA Templates,
operationId: bulkSendTemplates
tags:
- Bulk Send SLA Template
requestBody:
description: None
required: true
content:
application/json:
schema:
type: object
description: Shipper Contract SLA Template ids
properties:
shipperContractSlaTemplateIds:
type: array
items:
type: string
responses:
'200':
description: Successfully matched and sent bulk template slas
content:
application/json:
schema:
type: object
description: List of bulk SLA template info
properties:
success:
type: array
items:
type: string
failed:
type: array
items:
type: string
default:
$ref: '#/paths/~1v1~1routes/get/responses/404'
components:
securitySchemes:
bearer:
type: http
scheme: bearer
description: 'Standard JWT bearer token used for authenticated OmniPoint users
and internal service-to-service calls. Clients send `Authorization: Bearer <jwt>`
and the token is validated using the shared Core access token secret.
'
ApiKey:
type: apiKey
in: header
name: X-ONERAIL-API-KEY
description: 'Shared secret key used for machine-to-machine integrations. Must be sent
together with `X-ONERAIL-APP-ID` and is validated against the stored ApiAuth
record for that application.
'
AppId:
type: apiKey
in: header
name: X-ONERAIL-APP-ID
description: 'Application identifier (UUID) that pairs with `X-ONERAIL-API-KEY` for
machine-to-machine integrations. Both headers are required for ApiKey-based
authentication.
'
OAuth:
type: oauth2
description: 'OAuth 2.0 access token validated by the Operations service (e.g. Okta-backed
integrations). Clients obtain tokens from their own IdP outside of this API
and call endpoints with `Authorization: OAuth <access_token>`. The
`authorizationUrl` and `tokenUrl` values below are placeholders only to
satisfy the OpenAPI schema; this service does not call them directly and the
real IdP URLs are configured via environment and introspection logic in code.
'
flows:
authorizationCode:
authorizationUrl: https://dummy-unused-url.com
tokenUrl: https://dummy-unused-url.com
scopes: {}