apimodel

package

v0.3.0 Latest Latest Go to latest Published: Feb 8, 2021 License: BSD-3-Clause Imports: 1 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bassosimone/apiclient

Links

Open Source Insights

Documentation ¶

Overview ¶

Package apimodel describes all the implemented APIs. You need to edit this package to add/remove/modify APIs. Once you are done editing, remember to run `go generate ./...` to regenerate apiclient files.

Constants ¶

This section is empty.

Variables ¶

View Source

var Descriptors = []Descriptor{{
	Method:   "GET",
	URLPath:  URLPath{Value: "/api/_/check_report_id"},
	Request:  datamodel.CheckReportIDRequest{},
	Response: datamodel.CheckReportIDResponse{},
}, {
	Method:   "POST",
	URLPath:  URLPath{Value: "/api/v1/check-in"},
	Request:  datamodel.CheckInRequest{},
	Response: datamodel.CheckInResponse{},
}, {
	Method:   "POST",
	URLPath:  URLPath{Value: "/api/v1/login"},
	Request:  datamodel.LoginRequest{},
	Response: datamodel.LoginResponse{},
}, {
	Method:   "GET",
	URLPath:  URLPath{Value: "/api/v1/measurement_meta"},
	Request:  datamodel.MeasurementMetaRequest{},
	Response: datamodel.MeasurementMetaResponse{},
}, {
	Method:   "POST",
	URLPath:  URLPath{Value: "/api/v1/register"},
	Request:  datamodel.RegisterRequest{},
	Response: datamodel.RegisterResponse{},
}, {
	Method:   "GET",
	URLPath:  URLPath{Value: "/api/v1/test-helpers"},
	Request:  datamodel.TestHelpersRequest{},
	Response: datamodel.TestHelpersResponse{},
}, {
	Method:        "GET",
	URLPath:       URLPath{Value: "/api/v1/test-list/psiphon-config"},
	Request:       datamodel.PsiphonConfigRequest{},
	Response:      datamodel.PsiphonConfigResponse{},
	RequiresLogin: true,
}, {
	Method:        "GET",
	URLPath:       URLPath{Value: "/api/v1/test-list/tor-targets"},
	Request:       datamodel.TorTargetsRequest{},
	Response:      datamodel.TorTargetsResponse{},
	RequiresLogin: true,
}, {
	Method:   "GET",
	URLPath:  URLPath{Value: "/api/v1/test-list/urls"},
	Request:  datamodel.URLsRequest{},
	Response: datamodel.URLsResponse{},
}, {
	Method:   "POST",
	URLPath:  URLPath{Value: "/report"},
	Request:  datamodel.OpenReportRequest{},
	Response: datamodel.OpenReportResponse{},
}, {
	Method: "POST",
	URLPath: URLPath{
		InSwagger:  "/report/{report_id}",
		IsTemplate: true,
		Value:      "/report/{{ .ReportID }}",
	},
	Request:  datamodel.SubmitMeasurementRequest{},
	Response: datamodel.SubmitMeasurementResponse{},
}}

Descriptors contains all descriptors.

Functions ¶

This section is empty.

Types ¶

type Descriptor ¶

type Descriptor struct {
	Method        string
	URLPath       URLPath
	Request       interface{}
	Response      interface{}
	RequiresLogin bool
}

Descriptor is an API descriptor.

type URLPath ¶

type URLPath struct {
	IsTemplate bool
	Value      string
	InSwagger  string
}

URLPath describes the URLPath.

Source Files ¶

View all Source files

apimodel.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL