Categorygithub.com/spaceapi-community/go-spaceapi-validator-client

# README

Go API client for spaceapivalidatorclient

This is the SpaceApi Validator api

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.2.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./spaceapivalidatorclient"

Documentation for API Endpoints

All URIs are relative to https://validator.spaceapi.io

ClassMethodHTTP requestDescription
V1ApiV1GetGet /v1
V1ApiV1ValidatePostPost /v1/validate/validate an input against the SpaceApi schema
V2ApiV2GetGet /v2
V2ApiV2ValidateJSONPostPost /v2/validateJSONvalidate an input against the SpaceApi schema
V2ApiV2ValidateURLPostPost /v2/validateURLvalidate an input against the SpaceApi schema

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.

# Structs

APIClient manages communication with the SpaceApi Validator API v1.2.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
SchemaError struct for SchemaError.
ServerInformation struct for ServerInformation.
ValidateJsonV2Response struct for ValidateJsonV2Response.
ValidateUrlV2 struct for ValidateUrlV2.
ValidateUrlV2Response struct for ValidateUrlV2Response.
ValidateV1 struct for ValidateV1.
ValidateV1Response struct for ValidateV1Response.

# Type aliases

V1ApiService V1Api service.
V2ApiService V2Api service.