Giter VIP home page Giter VIP logo

flotilla-openapi's Introduction

Flotilla-openapi

A formated version of the API specification can be found here.

To generate locally: Follow the description in the pythonpublish.yml workflow except the last step.

Editing API-specification

For editing the API-specification in openapi.yaml the openapi-editor can be used. This can be installed by running npm -g install openapi-editor. To edit the file run npx openapi-editor --file openapi.yaml.

flotilla-openapi's People

Contributors

aestene avatar anetteu avatar christdej avatar nicholasdalhaug avatar vetlek avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

flotilla-openapi's Issues

Use different models for POST and GET /robots

Describe the improvement you would like to see
Currently these use the same model Robot where GET /robots returns robots in that model while POST /robots expects a json to be provided which may be transformed into this model. However, this means the POST expects an ID in the structure which will not be used for anything because the ID is generated my the database. Instead these should use different models where POST does not have to specify parameters which are not required.

Note that the model should be created and added to flotilla-openapi first and then implemented through flotilla.

How will this change existing functionality?
It will make it more user friendly to call the POST endpoint.

How will this improvement affect the current Threat Model?
Should not be affected.

Corresponding issue in flotilla: equinor/flotilla#149

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.