Kayhan Space Orbital Determination API

openapi: 3.1.0
info:
  title: Satcat Service Authentication Orbital Determination API
  description: '

    Kayhan Space''s Satcat Service API.


    ## Features

    * **View** historical CDM data for an object.

    * **View** latest CDM data for an object.

    '
  contact:
    email: help@kayhan.space
  version: 1.0.0
servers:
- url: /api/satcat
tags:
- name: Orbital Determination
paths:
  /od/{object_id}/upload:
    post:
      tags:
      - Orbital Determination
      summary: Upload Gnss File
      description: Upload a supported OD data file for a specific object.
      operationId: upload_gnss_file_od__object_id__upload_post
      security:
      - Oauth2Scheme: []
      parameters:
      - name: object_id
        in: path
        required: true
        schema:
          type: integer
          description: The norad/temporary id of the object.
          title: Object Id
        description: The norad/temporary id of the object.
      - name: group_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          description: Optional group ID to use for the request
          title: Group Id
        description: Optional group ID to use for the request
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_upload_gnss_file_od__object_id__upload_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /od/objects:
    get:
      tags:
      - Orbital Determination
      summary: List Od Objects
      description: List the objects for which OD files are available.
      operationId: list_od_objects_od_objects_get
      security:
      - Oauth2Scheme: []
      parameters:
      - name: group_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          description: Optional group ID to use for the request
          title: Group Id
        description: Optional group ID to use for the request
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /od/{object_id}:
    get:
      tags:
      - Orbital Determination
      summary: List Od Files
      description: Get list of OD files for a specific object.
      operationId: list_od_files_od__object_id__get
      security:
      - Oauth2Scheme: []
      parameters:
      - name: object_id
        in: path
        required: true
        schema:
          type: integer
          description: The norad/temporary id of the object.
          title: Object Id
        description: The norad/temporary id of the object.
      - name: today
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Today
      - name: results
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Results
      - name: search
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Optional case-insensitive substring filter applied to available filenames.
          title: Search
        description: Optional case-insensitive substring filter applied to available filenames.
      - name: group_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          description: Optional group ID to use for the request
          title: Group Id
        description: Optional group ID to use for the request
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Offset
      - name: count
        in: query
        required: false
        schema:
          type: integer
          maximum: 10001
          minimum: 0
          default: 50
          title: Count
      - name: sort_field
        in: query
        required: false
        schema:
          type: string
          default: last_modified
          title: Sort Field
      - name: sort_direction
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/SortDirection'
          default: desc
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /od/{object_id}/file:
    get:
      tags:
      - Orbital Determination
      summary: Download File Content
      description: Download a file from the OD file share.
      operationId: download_file_content_od__object_id__file_get
      security:
      - Oauth2Scheme: []
      parameters:
      - name: object_id
        in: path
        required: true
        schema:
          type: integer
          description: The norad/temporary id of the object.
          title: Object Id
        description: The norad/temporary id of the object.
      - name: group_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          description: Optional group ID to use for the request
          title: Group Id
        description: Optional group ID to use for the request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              description: The request body containing the file name.
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /od-leop:
    get:
      tags:
      - Orbital Determination
      summary: List Leop Launches
      description: List the available launches in the satcat OD LEOP folder
      operationId: list_leop_launches_od_leop_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - Oauth2Scheme: []
  /od-leop/{launch_folder}:
    get:
      tags:
      - Orbital Determination
      summary: Get Leop Tles
      description: Fetch the TLEs text file for a specific launch
      operationId: get_leop_tles_od_leop__launch_folder__get
      security:
      - Oauth2Scheme: []
      parameters:
      - name: launch_folder
        in: path
        required: true
        schema:
          type: string
          description: The folder name for the launch in the OD LEOP directory.
          title: Launch Folder
        description: The folder name for the launch in the OD LEOP directory.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /od/{object_id}/attributes:
    get:
      tags:
      - Orbital Determination
      summary: Get Rso Attributes
      description: Get RSO attributes for an asset from the satcat database.
      operationId: get_rso_attributes_od__object_id__attributes_get
      security:
      - Oauth2Scheme: []
      parameters:
      - name: object_id
        in: path
        required: true
        schema:
          type: integer
          description: The norad/temporary id of the object.
          title: Object Id
        description: The norad/temporary id of the object.
      - name: group_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          description: Optional owner group ID to scope the lookup.
          title: Group Id
        description: Optional owner group ID to scope the lookup.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SortDirection:
      type: string
      enum:
      - asc
      - desc
      title: SortDirection
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Body_upload_gnss_file_od__object_id__upload_post:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
          description: The OD data file to upload. Supported names include gnss_*.json|csv|navsol, maneuver_*.opm|txt, and azel_*.json.
      type: object
      title: Body_upload_gnss_file_od__object_id__upload_post
  securitySchemes:
    Oauth2Scheme:
      type: oauth2
      flows:
        password:
          scopes:
            internal: Access from an internal API.
          tokenUrl: login
        clientCredentials:
          scopes:
            internal: Access from an internal API.
          tokenUrl: oauth/token