modulepackage
0.0.0-20241212063937-e5f3434c32cf
Repository: https://github.com/ortelius/scec-environment.git
Documentation: pkg.go.dev
# README
Ortelius v11 Environment Microservice
Version 11.0.0
RestAPI for the Environment Object
Path Table
| Method | Path | Description |
|---|---|---|
| GET | /msapi/environment | Get a List of Environments |
| POST | /msapi/environment | Create a Environment |
| GET | /msapi/environment/:key | Get a Environment |
Reference Table
| Name | Path | Description |
|---|
Path Details
[GET]/msapi/environment
-
Summary
Get a List of Environments -
Description
Get a list of environments for the user.
Responses
- 200 OK
[POST]/msapi/environment
-
Summary
Create a Environment -
Description
Create a new Environment and persist it
Responses
- 200 OK
[GET]/msapi/environment/:key
-
Summary
Get a Environment -
Description
Get a environment based on the _key or name.
Responses
- 200 OK
References
# Packages
Package docs Code generated by swaggo/swag.
# Functions
GetEnvironment godoc @Summary Get a Environment @Description Get a environment based on the _key or name.
GetEnvironments godoc @Summary Get a List of Environments @Description Get a list of environments for the user.
NewEnvironment godoc @Summary Create a Environment @Description Create a new Environment and persist it @Tags Environment @Accept application/json @Produce json @Success 200 @Router /msapi/environment [post].