README.md

Senwisetool REST API Specifications

This repository contains the specification files for senwisetool REST APIs.

table of content

• local setup
• how to render the
• API tags

setup repo locally

• Clone repo with

    git clone git@github.com:frckbrice/senwisetool-api_spec.git

• Navigate to project : the target is to access the senwisetool.yaml file for build.

    cd senwisetool-api_spec/swt_api_spec

How to render the documentation

• Start local server for the spec in watch mode (you could just enter cd swt_api_apec && redocly build-docs senwisetool.yaml)

    - npm install -g @redocly/cli@latest
    - redocly build-docs senwisetool.yaml
    - redocly preview-docs senwisetool.yaml

• after the preview on client finished build, you can follow the displayed link to browser and Voila.

Available scripts

   npm run
  Scripts available in @swt/senwisetool-rest-api-specifications@1.0.0 via `npm run-script`:
    preview
      redocly preview-docs
    bundle
      redocly bundle
    bundle-deref
      redocly bundle -d true
    lint-redocly
      redocly --format summary lint

Available specifications

OpenAPI 3.0.3

The OpenAPI specification is a programming language agnostic standard that lets providers describe the interface of their HTTP APIs. This allows both humans and machines to discover the capabilities of an API without needing to first read documentation or understand the implementation.

API Name	Version
Users	v1
Projects	v1
Subscriptions	v1
Farms	v1
Training	v1
Companies	v1
Markets	v1
Transactions	v1
project_audits	v1
Collector_agents	v1
Farm_coordinates	v1
Requirements	v1
Price_plan	v2
Campaigns	v1
Stock_campaigns	v1

WIP (Work in Progress)

Thanks 🚀