DetroitApi.yaml

openapi: 3.0.3
info:
  version: '0.1'
  title: 'Detroit API'
  description: |
    # Detroit API Overview
    Work in progess...
    
  termsOfService: ""
  contact:
    name: LY Cheng
    url: 
    email: lyforever62@hotmail.com
  license:
    name: MIT License
    url: https://github.com/yhsiang/detroit/LICENSE

servers:
  - url: 'localhost:3000/api'
    description: Detroit API

paths:
  /fork:
    get:
      summary: Fork
      description: 'Fork a new simulation environment with current block height.'
      responses:
        '200':
          description: 'Request succeeded'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForkResponse'
  /:forkId:
    post: 
      summary: Call Ethereum JSON-RPC
      description: 'Call Ethereum JSON-RPC'
      requestBody:
        description: 'Ethereum JSON-RPC'
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonRpcRequest'
      responses:
        '200':
          description: 'Request succeeded'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonRpcResponse'
  /unfork:
    post:
      summary: Remove simulation environment
      description: 'Remove simulation environment'
      requestBody:
        description: 'Unfork Request'
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnforkRequest'
      responses:
        '200':
          description: 'Request succeeded'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
      
components:
  schemas:
    ForkResponse:
      type: object
      required:
        - forkId
        - address
        - signature
      properties:
        forkId:
          type: string
        address:
          type: string
          description: Account Address
        blockNumber:
          type: string
    JsonRpcRequest:
      type: object
      required:
        - jsonrpc
        - id
        - method
        - params
      properties:
        id:
          type: number
        jsonrpc:
          type: string
        method:
          type: string
          description: Method
        params:
          type: array
          description: Parameters
    JsonRpcResponse:
      type: object
      required:
        - jsonrpc
        - id
        - result
      properties:
        jsonrpc:
          type: string
          description: Version of Json Rpc
        id:
          type: number
          description: Id of Json Rpc
        result:
          oneOf: 
            - type: string
            - type: number
            - type: object
            - type: array
          description: Result of Json Rpc
    UnforkRequest:
      type: object
      required:
        - forkId
      properties:
        forkId:
          type: string
    Message:
      type: object
      required:
        - message
      properties:
        message:
          type: string
          description: succeeded message