swagger

README

Go API client for swagger

OpenAPI for https://codesearch.debian.net/

Overview

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

• API version: 1.4.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

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

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://codesearch.debian.net/api/v1

Class	Method	HTTP request	Description
SearchApi	Search	Get /search	Searches through source code
SearchApi	Searchperpackage	Get /searchperpackage	Like /search, but aggregates per package

Documentation For Models

• PackageSearchResult
• SearchResult

Documentation For Authorization

api_key

• Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

stapelberg@debian.org

Documentation

Index

• Variables
• func CacheExpires(r *http.Response) time.Time
• type APIClient
  • func NewAPIClient(cfg *Configuration) *APIClient
  • func (c *APIClient) ChangeBasePath(path string)
• type APIKey
• type APIResponse
  • func NewAPIResponse(r *http.Response) *APIResponse
  • func NewAPIResponseWithError(errorMessage string) *APIResponse
• type BasicAuth
• type Configuration
  • func NewConfiguration() *Configuration
  • func (c *Configuration) AddDefaultHeader(key string, value string)
• type GenericSwaggerError
  • func (e GenericSwaggerError) Body() []byte
  • func (e GenericSwaggerError) Error() string
  • func (e GenericSwaggerError) Model() interface{}
• type PackageSearchResult
• type SearchApiSearchOpts
• type SearchApiSearchperpackageOpts
• type SearchApiService
  • func (a *SearchApiService) Search(ctx context.Context, query string, localVarOptionals *SearchApiSearchOpts) ([]SearchResult, *http.Response, error)
  • func (a *SearchApiService) Searchperpackage(ctx context.Context, query string, ...) ([]PackageSearchResult, *http.Response, error)
• type SearchResult

Variables

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient

type APIClient struct {
	SearchApi *SearchApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Debian Code Search API v1.4.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

type GenericSwaggerError

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type PackageSearchResult

type PackageSearchResult struct {
	// The Debian source package for which up to 2 search results have been aggregated in `results`.
	Package_ string         `json:"package"`
	Results  []SearchResult `json:"results"`
}

type SearchApiSearchOpts

type SearchApiSearchOpts struct {
	MatchMode optional.String
}

type SearchApiSearchperpackageOpts

type SearchApiSearchperpackageOpts struct {
	MatchMode optional.String
}

type SearchApiService

type SearchApiService service

func (*SearchApiService) Search

func (a *SearchApiService) Search(ctx context.Context, query string, localVarOptionals *SearchApiSearchOpts) ([]SearchResult, *http.Response, error)

func (*SearchApiService) Searchperpackage

func (a *SearchApiService) Searchperpackage(ctx context.Context, query string, localVarOptionals *SearchApiSearchperpackageOpts) ([]PackageSearchResult, *http.Response, error)

type SearchResult

type SearchResult struct {
	// The Debian source package containing this search result, including the full Debian version number.
	Package_ string `json:"package"`
	// Path to the file containing the this search result, relative to `package`.
	Path string `json:"path"`
	// Line number containing the search result.
	Line int32 `json:"line"`
	// Up to 2 full lines before the search result (see `context`).
	ContextBefore []string `json:"context_before,omitempty"`
	// The full line containing the search result.
	Context string `json:"context"`
	// Up to 2 full lines after the search result (see `context`).
	ContextAfter []string `json:"context_after,omitempty"`
}

A search result matching the specified query. You can use sources.debian.org to view the file contents. See https://github.com/Debian/dcs/blob/master/cmd/dcs-web/show/show.go for how to construct a sources.debian.org URL from a search result.