55bdebe8b2
* internal/engine/ooapi: auto-generated API client * feat: introduce the callers abstraction * feat: implement API caching on disk * feat: implement cloneWithToken when we require login * feat: implement login * fix: do not cache all APIs * feat: start making space for more tests * feat: implement caching policy * feat: write tests for caching layer * feat: add integration tests and fix some minor issues * feat: write much more unit tests * feat: add some more easy unit tests * feat: add tests that use a local server While there, make sure many fields we care about are OK. * doc: write basic documentation * fix: tweak sentence * doc: improve ooapi documentation * doc(ooapi): other documentation improvements * fix(ooapi): remove caching for most APIs We discussed this topic yesterday with @FedericoCeratto. The only place where we want LRU caching is MeasurementMeta. * feat(ooapi): improve handling of errors during login This was also discussed yesterday with @FedericoCeratto * fix(swaggerdiff_test.go): temporarily disable Before I work on this, I need to tend onto other tasks. * fix(ootest): add one more test case We're going towards 100% coverage of this package, as it ought to be. * feat(ooapi): test cases for when the probe clock is off * fix(ooapi): change test to have 100% unittest coverage * feat: sync server and client APIs definition Companion PR: https://github.com/ooni/api/pull/218 * fix(ooapi): start testing again against API * fix(ooapi): only generate each file once * chore: set version to 3.7.0-alpha While there, make sure we don't always skip a currently failing riseupvpn test, and slightly clarify the readme. * fix(kvstore): less scoped error message
23 lines
902 B
Go
23 lines
902 B
Go
// Package apimodel describes the data types used by OONI's API.
|
|
//
|
|
// If you edit this package to integrate the data model, remember to
|
|
// run `go generate ./...`.
|
|
//
|
|
// We annotate fields with tagging. When a field should be sent
|
|
// over as JSON, use the usual `json` tag.
|
|
//
|
|
// When a field needs to be sent using the query string, use
|
|
// the `query` tag instead. We limit what can be sent using the
|
|
// query string to int64, string, and bool.
|
|
//
|
|
// The `path` tag indicates that the URL path contains a
|
|
// template. We will replace the value of this field with
|
|
// the template. Note that the template should use the
|
|
// Go name of the field (e.g. `{{ .ReportID }}`) as opposed
|
|
// to the name in the tag, which is only used when we
|
|
// generate the API Swagger.
|
|
//
|
|
// The `required` tag indicates required fields. A required
|
|
// field cannot be empty (for the Go definition of empty).
|
|
package apimodel
|