package tezos-openapi

You can search for identifiers within the package.

in-package search v0.2.0

tezos-openapi
- Tezos_openapi
  - Api
  - Convert
    
    String_map
  - Json
  - Method
  - Openapi
    
    Endpoint
    
    Parameter
    
    Path
    
    Response
    
    Schema
    
    Server
    
    Service

Legend:
Library
Module
Module type
Parameter
Class
Class type

OpenAPI specifications.

This is not a general library, in particular it does not support content-types other than application/json. It only supports what we actually use.

module Schema : sig ... end

OpenAPI Schema Objects.

module Response : sig ... end

module Parameter : sig ... end

module Service : sig ... end

module Path : sig ... end

module Endpoint : sig ... end

API endpoints, i.e. paths associated with one or more HTTP methods.

module Server : sig ... end

type t = {

title : string;
description : string option;
version : string;
servers : Server.t list;
definitions : (string * Schema.t) list;
endpoints : Endpoint.t list;

}

val make : 
  title:string ->
  ?description:string ->
  version:string ->
  ?servers:Server.t list ->
  ?definitions:(string * Schema.t) list ->
  Endpoint.t list ->
  t

val to_json : t -> Json.u

val of_json : Json.t -> t