Giter VIP home page Giter VIP logo

engage-digital-api-docs's Introduction

engage-digital-api-docs's People

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

engage-digital-api-docs's Issues

OpenAPI Spec update for server variable

The server parameter has a variable which should be expanded per OAS3.

Here's an example from the Swagger.io documentation:

https://swagger.io/specification/#server-object-example

servers:
- url: https://{username}.gigantic-server.com:{port}/{basePath}
  description: The production API server
  variables:
    username:
      # note! no enum here means it is an open value
      default: demo
      description: this value is assigned by the service provider, in this example `gigantic-server.com`
    port:
      enum:
        - '8443'
        - '443'
      default: '8443'
    basePath:
      # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2`
      default: v2

The current version indicates a variable using angle brackets.

servers:
  - url: 'https://<yourdomain>.api.engagement.dimelo.com/1.0'

Swaggman dependency does not work.

Apparently, github.com/grokify/swaggman was renamed to github.com/grokify/spectrum

I tried to replace it, but the spectrum is not compatible with [email protected]

It raises the error:

> go version #go version go1.15.15 darwin/amd64(OSX)
> go get github.com/grokify/spectrum
../../../../go/pkg/mod/github.com/grokify/[email protected]/encoding/jsonutil/jsonutil.go:9:2: package io/fs is not in GOROOT (/usr/local/Cellar/[email protected]/1.15.15/libexec/src/io/fs)

Same in CI: https://github.com/ringcentral/engage-digital-api-docs/runs/3349668209?check_suite_focus=true

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.