Categorygithub.com/ortelius/scec-user
modulepackage
0.0.0-20241212064952-9b1137c5ab1e
Repository: https://github.com/ortelius/scec-user.git
Documentation: pkg.go.dev

# README

Ortelius v11 User Microservice

Version 11.0.0

RestAPI for the User Object Release license

Build MegaLinter CodeQL OpenSSF-Scorecard

Discord

Path Table

MethodPathDescription
GET/msapi/userGet a List of Users
POST/msapi/userCreate a User
GET/msapi/user/:keyGet a User

Reference Table

NamePathDescription

Path Details


[GET]/msapi/user

  • Summary
    Get a List of Users

  • Description
    Get a list ofthe user.

Responses

  • 200 OK

[POST]/msapi/user

  • Summary
    Create a User

  • Description
    Create a new User and persist it

Responses

  • 200 OK

[GET]/msapi/user/:key

  • Summary
    Get a User

  • Description
    Get a user based on the _key or name.

Responses

  • 200 OK

References

# Packages

Package docs Code generated by swaggo/swag.

# Functions

GetUser godoc @Summary Get a User @Description Get a user based on the _key or name.
GetUsers godoc @Summary Get a List of Users @Description Get a list ofthe user.
NewUser godoc @Summary Create a User @Description Create a new User and persist it @Tags user @Accept application/json @Produce json @Success 200 @Router /msapi/user [post].