Openapi

nickbetteridge · May 23, 2019, 8:31am

Hi,
Are there any Openapi yaml or json files for your rest apis? We generate all of our bindings and ensure they are type-safe. If there aren’t any, would it be possible for you to create them, thus providing us with an official contract between client and server?
Thanks
Nick

mirzak · May 23, 2019, 8:39am

I believe that all services have a yaml file containing the API definitions, e.g

github.com

mendersoftware/deployments/blob/master/docs/devices_api.yml

swagger: '2.0'
info:
  title: Deployments
  version: '1'
  description: |
    An API for device firmware deployments. Intended for use by devices.

    Devices can get new updates and send information about current deployment status.

host: 'docker.mender.io'
basePath: '/api/devices/v1/deployments'
schemes:
  - https

responses:
  NotFoundError: # 404
    description: Not Found.
    schema:
      $ref: "#/definitions/Error"
  InternalServerError: # 500

This file has been truncated. show original

Though I do not believe that we one file for all device API`s instead there is one definition for each service.

nickbetteridge · May 23, 2019, 8:50am

Excellent - thanks - just what I was after!

Topic		Replies	Views
REST API get list of device ID's from deployment General Discussions	12	1165	October 23, 2020
Finding the last deployment for a group using REST API General Discussions api , management-api	1	344	June 30, 2021
Get Deployment Log for Device General Discussions	0	271	April 1, 2022
Using API to get artifact name General Discussions api	8	516	July 18, 2022
File Transfer using Mender-CLI and API General Discussions api , mender-cli	15	753	July 26, 2021

Openapi

Related Topics