org.alephium.api.Examples.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alephium-api_2.13 Show documentation

alephium-api

There is a newer version: 3.8.8

// Copyright 2018 The Alephium Authors
// This file is part of the alephium project.
//
// The library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the library. If not, see .

package org.alephium.api

import sttp.tapir.EndpointIO.Example

trait Examples {
  def simpleExample[T](t: T): List[Example[T]] = List(Example(t, None, None))
  def defaultExample[T](t: T): Example[T]      = Example(t, None, Some("Default"))
  def moreSettingsExample[T](t: T): Example[T] = Example(t, None, Some("More settings"))
  def moreSettingsExample[T](t: T, summary: String): Example[T] = Example(t, None, Some(summary))
}