openapi: 3.0.2
info:
title: Polymath API Service CANBus systemd API
description: Polymath API service to interact with a real or simulated polymath-powered robot
termsOfService: https://www.polymathrobotics.com/legal/terms-of-service
contact:
name: Polymath Support
url: https://www.polymathrobotics.com
email: api@polymathrobotics.com
license:
name: All rights reserved
url: https://www.polymathrobotics.com/legal/privacy-policy
version: 2.0.0
tags:
- name: systemd
paths:
/v2/systemd/{path}:
get:
tags:
- systemd
summary: Proxy Systemd Request
description: 'Reverse proxy for Polymath systemd API requests. Please refer to the API documentation for details on available endpoints.
Forwards all requests under /v2/systemd/* to the systemd API service
at POLYMATH_SYSTEMD_API_IP:POLYMATH_SYSTEMD_API_PORT.
E.g. to list user services, send a GET request to: `/v2/systemd/list/user`'
operationId: proxy_systemd_request
parameters:
- required: true
schema:
title: Path
type: string
name: path
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- systemd
summary: Proxy Systemd Request
description: 'Reverse proxy for Polymath systemd API requests. Please refer to the API documentation for details on available endpoints.
Forwards all requests under /v2/systemd/* to the systemd API service
at POLYMATH_SYSTEMD_API_IP:POLYMATH_SYSTEMD_API_PORT.
E.g. to list user services, send a GET request to: `/v2/systemd/list/user`'
operationId: proxy_systemd_request
parameters:
- required: true
schema:
title: Path
type: string
name: path
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
HTTPValidationError:
title: HTTPValidationError
type: object
properties:
detail:
title: Detail
type: array
items:
$ref: '#/components/schemas/ValidationError'
ValidationError:
title: ValidationError
required:
- loc
- msg
- type
type: object
properties:
loc:
title: Location
type: array
items:
anyOf:
- type: string
- type: integer
msg:
title: Message
type: string
type:
title: Error Type
type: string
securitySchemes:
HTTPBearer:
type: http
scheme: bearer