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