package
2.0.0-beta.1+incompatible
Repository: https://github.com/wepala/weos.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
AuthorizationInitializer setup authorization.
Context CreateHandler go context and add parameter values to context.
ContextInitializer add context middleware to path.
ConvertFormToJson This function is used for "application/x-www-form-urlencoded" content-type to convert req body to json.
ConvertStringToType convert open api schema types to go data types.
CORsInitializer sets up CORs for a specific path.
Deprecated: 06/04/2022 moved this to the gorm projectionCreateSchema creates the table schemas for gorm syntax.
CSVUpload parse csv and add items as "_items" to context.
DefaultEventStore setup default gorm projection.
DefaultListController handles the read operations viewing a list of items.
DefaultProjection setup default gorm projection.
DefaultReadController handles the read operations viewing a specific item.
DefaultWriteController handles the write operations (create, update, delete).
EntityRepositoryInitializer setups the EntityFactory for a specific route.
No description provided by the author
GetEntityRepository get the configured event factory from the context.
Deprecated: 06/20/2022 Use GetOpenIDConfig to get the map of the entire configGetJwkUrl fetches the jwk url from the open id connect url.
GetOpenIDConfig returns map of openID content.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetSchemaBuilders get a map of the dynamic struct builders for the schemas from the context.
No description provided by the author
No description provided by the author
JSONMarshal this marshals data without using html.escape.
LoadHttpRequestFixture wrapper around the test helper to make it easier to use it with test table.
LoadHttpResponseFixture wrapper around the test helper to make it easier to use it with test table.
No description provided by the author
No description provided by the author
Used to get the logLvl equivalent for an inputted level string.
MultiWriter creates a writer that duplicates its writes to all the provided writers, similar to the Unix tee(1) command.
New instantiates and initializes the api.
No description provided by the author
NewEtag This takes in a contentEntity and concatenates the weosID and SequenceID.
NewRespBodyFromBytes creates an io.ReadCloser from a byte slice that is suitable for use as an http response body.
No description provided by the author
RegisterEntityRepositories registers the entity repositories based on the schema definitions.
RequestID generate request id.
No description provided by the author
ReturnContextValues pulls out all the values stored in the context and adds it to a map to be returned.
RouteInitializer creates route using information in the initialization context.
SaveUploadedFiles this is a supporting function for ConvertFormtoJson.
Security adds authorization middleware to the initialize context.
Serve API.
SplitEtag This takes an Etag and returns the weosID and sequence number.
SplitFilter splits a filter with a single value into the field, operator, value.
SplitFilters splits multiple filters into array of filters.
SplitQueryParameters is used to split key value pair query parameters.
SQLDatabase initial sql databases based on configs.
StandardInitializer adds standard controller and middleware if not already setup.
No description provided by the author
UserDefinedInitializer adds user defined middleware, controller, command dispatchers and event store to the initialize context.
ZapLogger switches the echo context logger to be ZapLogger.
ZapLoggerInitializer add middleware to all paths to log the request and setup zap logger.

# Constants

AliasExtension alias parameter name to a different name in the controller.
AuthorizationConfigExtension setup authorization.
CommandDispatcherExtension set custom command dispatcher.
ContextExtension set parameters directly in the context.
ContextNameExtension alias parameter name to a different name in the context.
ControllerExtension set controller.
CopyExtension is used to copy a field's values into another field, ignoring those that are not of the same type.
EventStoreExtension set custom event store.
FileExtension set staticFolder file.
FolderExtension set staticFolder folder.
IdentifierExtension set identifier.
JWTMapExtension map claims to user and role.
MiddlewareExtension add middleware.
OpenIDConnectUrlExtension set the open id connect url.
ProjectionExtension set custom projection.
RemoveExtension marks a field for removal.
SchemaExtension alias for specifying the content type instead of the request body.
SkipExpiryCheckExtension set the expiry check.
No description provided by the author
No description provided by the author
TemplateExtension set template files.
No description provided by the author
UploadExtension for the storage location of an upload.
WeOSConfigExtension weos configuration key.

# Variables

No description provided by the author

# Structs

No description provided by the author
No description provided by the author
FilterProperties is the properties need to use filters.
HealthCheckResponse used int he health check controller to return a response with version.
No description provided by the author
ListApiResponse used in the list controller to return a response with total, page and items retrieved.
No description provided by the author
OpenIDConnect authorizer for OpenID.
No description provided by the author
QueryProperties is the properties needed to use key value pair query parameters.
No description provided by the author
RESTAPI is used to manage the API.
SecurityConfiguration mange the security configuration for the API.

# Interfaces

define an interface that all plugins must implement.
No description provided by the author
Validator interface that must be implemented so that a request can be authenticated.

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author