Charthop legalDoc API

The legalDoc API from Charthop — 2 operation(s) for legaldoc.

OpenAPI Specification

charthop-legaldoc-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  description: REST API for ChartHop
  version: V1.0.0
  title: ChartHop access legalDoc API
  contact:
    name: ChartHop
    url: https://www.charthop.com
    email: support@charthop.com
host: localhost
schemes:
- https
- http
consumes:
- application/json
produces:
- application/json
tags:
- name: legalDoc
paths:
  /v1/legaldoc:
    post:
      tags:
      - legalDoc
      summary: Create a legal doc
      operationId: createLegalDoc
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateLegalDoc'
      responses:
        '400':
          description: invalid data
        '401':
          description: not authorized
        '403':
          description: permission denied
  /v1/legaldoc/{name}:
    get:
      tags:
      - legalDoc
      summary: Retrieve the legal doc by name
      operationId: getLegalDoc
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: name
        in: path
        description: name
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/LegalDoc'
        '400':
          description: invalid data
        '401':
          description: not authorized
        '403':
          description: permission denied
definitions:
  Attribution:
    type: object
    properties:
      principalUserId:
        type: string
        example: 588f7ee98f138b19220041a7
      agentUserIds:
        type: array
        items:
          type: string
          example: 588f7ee98f138b19220041a7
      eventId:
        type: string
        example: 588f7ee98f138b19220041a7
      aiChatId:
        type: string
        example: 588f7ee98f138b19220041a7
      aiToolUseId:
        type: string
      channel:
        type: string
        enum:
        - WEB
        - MOBILE
        - SLACK
        - TEAMS
        - MCP
  LegalDoc:
    type: object
    required:
    - id
    - name
    - date
    properties:
      id:
        type: string
        description: globally unique id
        example: 588f7ee98f138b19220041a7
      name:
        type: string
        description: human-readable full name of form
        example: ChartHop Service Agreement
      content:
        type: string
        description: legal doc content
      date:
        type: string
        format: date
        description: content by date
      createId:
        type: string
        description: created by user id
        example: 588f7ee98f138b19220041a7
      createBehalfId:
        type: string
        description: created on behalf of user id
        example: 588f7ee98f138b19220041a7
      createAttribution:
        $ref: '#/definitions/Attribution'
      createAt:
        type: string
        description: created timestamp
        example: 2017-01-24T13:52Z
      updateId:
        type: string
        description: last updated by user id
        example: 588f7ee98f138b19220041a7
      updateBehalfId:
        type: string
        description: last updated on behalf of user id
        example: 588f7ee98f138b19220041a7
      updateAttribution:
        $ref: '#/definitions/Attribution'
      updateAt:
        type: string
        description: last updated timestamp
        example: '2017-01-24T13:57:52Z'
  CreateLegalDoc:
    type: object
    required:
    - name
    - content
    - date
    properties:
      name:
        type: string
        description: human-readable full name of form
        example: ChartHop Service Agreement
      content:
        type: string
        description: legal doc content
      date:
        type: string
        format: date
        description: content by date