Categorygithub.com/andrewshadura/go-obs
modulepackage
0.0.0-20220828140654-d182bfe1048a
Repository: https://github.com/andrewshadura/go-obs.git
Documentation: pkg.go.dev

# README

OBS API client in Go

go-obs is an API client for OBS, Open Build Service.

go-obs currently only covers a tiny part of the OBS API. It also provides a very basic command-line client tool.

Please note that this project has nothing to do with another OBS which is short for Open Broadcaster Software. If you’re looking for a Go client for that OBS, have a look at obsws.

API coverage

The client currently only supports most of the user and group manipulation operations.

License

Licensed under the Apache License, Version 2.0 (the ‘License’); you may not use this software except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0; it is also included as LICENSE with this software.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

# Packages

No description provided by the author

# Functions

CheckResponse checks the API response for errors, and returns them if present.
NewAPI returns a new OBS API client.
WithBaseURL sets the base URL for API requests to a custom endpoint.
No description provided by the author

# Structs

No description provided by the author
An ErrorResponse reports one or more errors caused by an API request.
Group represents a named group of users.
ProjectRef represents a project referred by its name.
No description provided by the author
User represents a user (a person in OBS terminology).
No description provided by the author
UserRef represents a user referred by their username.
No description provided by the author

# Type aliases

No description provided by the author