Giter VIP home page Giter VIP logo

on-http-api2.0-java's Introduction

swagger-java-client

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-java-client</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-java-client:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/swagger-java-client-1.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

import java.io.File;
import java.util.*;

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        UserObj body = new UserObj(); // UserObj | User information
        try {
            Object result = apiInstance.addUser(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#addUser");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost/api/2.0

Class Method HTTP request Description
ApiApi addUser POST /users Add a new user
ApiApi catalogsGet GET /catalogs get list of all catalogs
ApiApi catalogsIdGet GET /catalogs/{identifier} get list of all catalogs
ApiApi configGet GET /config get server configuration
ApiApi configPatch PATCH /config patch/update server configuration
ApiApi createTag POST /tags Create a new tag
ApiApi deleteTag DELETE /tags/{tagName} Delete the specified tag
ApiApi filesDelete DELETE /files/{fileidentifier} delete file based on uuid
ApiApi filesGet GET /files/{fileidentifier} get file based on uuid or file name
ApiApi filesGetAll GET /files get all available files
ApiApi filesMd5Get GET /files/{filename}/md5 get md5sum based on file name
ApiApi filesMetadataGet GET /files/{filename}/metadata get file metadata by file name
ApiApi filesPut PUT /files/{fileidentifier} put file based on filename
ApiApi getAllTags GET /tags Retrieve information about all tags
ApiApi getBootstrap GET /tasks/bootstrap.js get tasks bootstrap.js
ApiApi getNodesByTag GET /tags/{tagName}/nodes Retrieve nodes with the specified tag
ApiApi getTag GET /tags/{tagName} Retrieve information about the tag
ApiApi getTasksById GET /tasks/{identifier} get specific task
ApiApi getUser GET /users/{name} Get information about a user
ApiApi listUsers GET /users Retrieve a list of users
ApiApi lookupsDelById DELETE /lookups/{id} Delete specified lookup details.
ApiApi lookupsGet GET /lookups find all
ApiApi lookupsGetById GET /lookups/{id} lookup id
ApiApi lookupsPatchById PATCH /lookups/{id} Patch specified lookup record
ApiApi lookupsPost POST /lookups find all
ApiApi modifyUser PATCH /users/{name} Update properties on a user
ApiApi nodesDelById DELETE /nodes/{identifier} Delete specified node.
ApiApi nodesDelTagById DELETE /nodes/{identifier}/tags/{tagName} Delete a tag from the specified node.
ApiApi nodesGetAll GET /nodes List of all nodes or if there are none an empty object
ApiApi nodesGetById GET /nodes/{identifier} List of all nodes or if there are none an empty object
ApiApi nodesGetCatalogById GET /nodes/{identifier}/catalogs Fetch catalog of specified node
ApiApi nodesGetCatalogSourceById GET /nodes/{identifier}/catalogs/{source} Fetch catalog of specified node for given source
ApiApi nodesGetPollersById GET /nodes/{identifier}/pollers Fetch all pollers for specified node
ApiApi nodesGetSshById GET /nodes/{identifier}/ssh get the ssh settings associated with a node.
ApiApi nodesGetTagsById GET /nodes/{identifier}/tags List of all tags on the node or an empty object if there are none
ApiApi nodesGetWorkflowById GET /nodes/{identifier}/workflows Fetch all workflows for specified node
ApiApi nodesMasterDelTagById DELETE /nodes/tags/{tagName} Delete specified tag from all nodes.
ApiApi nodesPatchById PATCH /nodes/{identifier} Patch specified node
ApiApi nodesPatchTagById PATCH /nodes/{identifier}/tags Patch tags onto specified node
ApiApi nodesPost POST /nodes post
ApiApi nodesPostSshById POST /nodes/{identifier}/ssh set the ssh settings associated with a node.
ApiApi nodesPostWorkflowById POST /nodes/{identifier}/workflows create workflow for specified node
ApiApi nodesWorkflowActionById PUT /nodes/{identifier}/workflows/action Cancel currently running workflows for specified node
ApiApi obmsDefinitionsGetAll GET /obms/definitions Get list of possible OBM services
ApiApi obmsDefinitionsGetByName GET /obms/definitions/{name} Get the specified OBM service definition
ApiApi obmsDeleteById DELETE /obms/{identifier} Delete the OBM service with the specified identifier
ApiApi obmsGet GET /obms Get list of all OBM service instances
ApiApi obmsGetById GET /obms/{identifier} get the specified OBM service
ApiApi obmsPatchById PATCH /obms/{identifier} patch a single OBM service
ApiApi obmsPostLed POST /obms/led Enable or disable identify light on node through OBM (if supported)
ApiApi obmsPut PUT /obms create or update a single OBM service
ApiApi pollersCurrentDataGet GET /pollers/{identifier}/data/current Get latest data for the specific poller
ApiApi pollersDataGet GET /pollers/{identifier}/data Get data for the specific poller
ApiApi pollersDelete DELETE /pollers/{identifier} delete the specified poller
ApiApi pollersGet GET /pollers get list of all pollers
ApiApi pollersIdGet GET /pollers/{identifier} Get specifics of the specified poller
ApiApi pollersLibByIdGet GET /pollers/library/{identifier} get a single library poller
ApiApi pollersLibGet GET /pollers/library get list of possible library pollers
ApiApi pollersPatch PATCH /pollers/{identifier} patch specifics of the specified poller
ApiApi pollersPost POST /pollers create a poller
ApiApi postTaskById POST /tasks/{identifier} post specific task
ApiApi postWorkflowById POST /tags/{tagName}/nodes/workflows create workflow for nodes with the specified tag
ApiApi profilesGet GET /profiles get list of possible profiles
ApiApi profilesGetLibByName GET /profiles/library/{name} get a single profile's raw data
ApiApi profilesGetMetadata GET /profiles/metadata get list of possible profiles from database
ApiApi profilesGetMetadataByName GET /profiles/metadata/{name} get a single profile's metadata from database
ApiApi profilesGetSwitchVendor GET /profiles/switch/{vendor} get a single profile
ApiApi profilesPostSwitchError POST /profiles/switch/error create a switch error
ApiApi profilesPutLibByName PUT /profiles/library/{name} put a single profile
ApiApi removeUser DELETE /users/{name} Delete a user
ApiApi schemasGet GET /schemas get list of all schemas
ApiApi schemasIdGet GET /schemas/{identifier} get a schema by specifying its identifier
ApiApi skuPackPost POST /skus/pack get list of skus
ApiApi skusGet GET /skus get list of skus
ApiApi skusIdDelete DELETE /skus/{identifier} Delete specific sku.
ApiApi skusIdDeletePack DELETE /skus/{identifier}/pack Delete a pack for a specific sku
ApiApi skusIdGet GET /skus/{identifier} get a single sku
ApiApi skusIdGetNodes GET /skus/{identifier}/nodes get nodes for specific sku
ApiApi skusIdPutPack PUT /skus/{identifier}/pack put a sku pack to specific sku
ApiApi skusPatch PATCH /skus/{identifier} patch a single sku
ApiApi skusPost POST /skus create a sku
ApiApi skusPut PUT /skus create or update a sku
ApiApi templatesGetByName GET /templates/{name} get a single template
ApiApi templatesLibDelete DELETE /templates/library/{name} delete a single template
ApiApi templatesLibGet GET /templates/library/{name} get a single template
ApiApi templatesLibPut PUT /templates/library/{name} put a single template
ApiApi templatesMetaGet GET /templates/metadata get list of metadata for all templates
ApiApi templatesMetaGetByName GET /templates/metadata/{name} get metadata for a specific template
ApiApi unimplemented GET /dhcp get DHCP lease table
ApiApi unimplemented_0 GET /dhcp/lease/{mac} fetch lease information for the mac specified
ApiApi unimplemented_1 DELETE /dhcp/lease/{mac} get list of all catalogs
ApiApi unimplemented_2 GET /obms/led Fetch status of identify light on node through OBM (if supported)
ApiApi viewsDelete DELETE /views/{identifier} put a single view
ApiApi viewsGet GET /views get all views
ApiApi viewsGetById GET /views/{identifier} get view with specified identifier
ApiApi viewsPut PUT /views/{identifier} put a single view
ApiApi workflowsAction PUT /workflows/{identifier}/action Perform the specified action on the selected workflow
ApiApi workflowsDeleteByInstanceId DELETE /workflows/{identifier} Delete the workflow with the specified ID
ApiApi workflowsDeleteGraphsByName DELETE /workflows/graphs/{injectableName} Delete the graph with the specified injectable name
ApiApi workflowsDeleteTasksByName DELETE /workflows/tasks/{injectableName} Delete the task with the specified injectable name
ApiApi workflowsGet GET /workflows Get list of active and past run workflow instances
ApiApi workflowsGetAllTasks GET /workflows/tasks Get list of tasks possible to run in workflows
ApiApi workflowsGetByInstanceId GET /workflows/{identifier} get a specific workflow
ApiApi workflowsGetGraphs GET /workflows/graphs Get list of all graphs
ApiApi workflowsGetGraphsByName GET /workflows/graphs/{injectableName} Get the graph with the specified injectable name
ApiApi workflowsGetTasksByName GET /workflows/tasks/{injectableName} Get the task with the specified injectable name
ApiApi workflowsPost POST /workflows Run a new workflow
ApiApi workflowsPutGraphs PUT /workflows/graphs Add a graph to the graph library
ApiApi workflowsPutTask PUT /workflows/tasks Add tasks to task library

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issue.

Author

on-http-api2.0-java's People

Contributors

jlongever avatar

Watchers

 avatar

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.