mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-12-29 10:36:31 +00:00
fc3741365c
* Add Swagger spec test script * Fix Swagger spec errors not related to statuses with polls * Add API tests that post a status with a poll * Fix creating a status with a poll from form params * Fix Swagger spec errors related to statuses with polls (this is the last error) * Fix Swagger spec warnings not related to unused definitions * Suppress a duplicate list update params definition that was somehow causing wrong param names * Add Swagger test to CI - updates Drone config - vendorizes go-swagger - fixes a file extension issue that caused the test script to generate JSON instead of YAML with the vendorized version * Put `Sample: ` on its own line everywhere * Remove unused id param from emojiCategoriesGet * Add 5 more pairs of profile fields to account update API Swagger * Remove Swagger prefix from dummy fields It makes the generated code look weird * Manually annotate params for statusCreate operation * Fix all remaining Swagger spec warnings - Change some models into operation parameters - Ignore models that already correspond to manually documented operation parameters but can't be trivially changed (those with file fields) * Documented that creating a status with scheduled_at isn't implemented yet * sign drone.yml * Fix filter API Swagger errors * fixup! Fix filter API Swagger errors --------- Co-authored-by: tobi <tobi.smethurst@protonmail.com>
71 lines
2.9 KiB
Markdown
71 lines
2.9 KiB
Markdown
GoUtils
|
|
===========
|
|
[](https://masterminds.github.io/stability/maintenance.html)
|
|
[](https://godoc.org/github.com/Masterminds/goutils) [](https://travis-ci.org/Masterminds/goutils) [](https://ci.appveyor.com/project/mattfarina/goutils)
|
|
|
|
|
|
GoUtils provides users with utility functions to manipulate strings in various ways. It is a Go implementation of some
|
|
string manipulation libraries of Java Apache Commons. GoUtils includes the following Java Apache Commons classes:
|
|
* WordUtils
|
|
* RandomStringUtils
|
|
* StringUtils (partial implementation)
|
|
|
|
## Installation
|
|
If you have Go set up on your system, from the GOPATH directory within the command line/terminal, enter this:
|
|
|
|
go get github.com/Masterminds/goutils
|
|
|
|
If you do not have Go set up on your system, please follow the [Go installation directions from the documenation](http://golang.org/doc/install), and then follow the instructions above to install GoUtils.
|
|
|
|
|
|
## Documentation
|
|
GoUtils doc is available here: [](https://godoc.org/github.com/Masterminds/goutils)
|
|
|
|
|
|
## Usage
|
|
The code snippets below show examples of how to use GoUtils. Some functions return errors while others do not. The first instance below, which does not return an error, is the `Initials` function (located within the `wordutils.go` file).
|
|
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"github.com/Masterminds/goutils"
|
|
)
|
|
|
|
func main() {
|
|
|
|
// EXAMPLE 1: A goutils function which returns no errors
|
|
fmt.Println (goutils.Initials("John Doe Foo")) // Prints out "JDF"
|
|
|
|
}
|
|
Some functions return errors mainly due to illegal arguements used as parameters. The code example below illustrates how to deal with function that returns an error. In this instance, the function is the `Random` function (located within the `randomstringutils.go` file).
|
|
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"github.com/Masterminds/goutils"
|
|
)
|
|
|
|
func main() {
|
|
|
|
// EXAMPLE 2: A goutils function which returns an error
|
|
rand1, err1 := goutils.Random (-1, 0, 0, true, true)
|
|
|
|
if err1 != nil {
|
|
fmt.Println(err1) // Prints out error message because -1 was entered as the first parameter in goutils.Random(...)
|
|
} else {
|
|
fmt.Println(rand1)
|
|
}
|
|
|
|
}
|
|
|
|
## License
|
|
GoUtils is licensed under the Apache License, Version 2.0. Please check the LICENSE.txt file or visit http://www.apache.org/licenses/LICENSE-2.0 for a copy of the license.
|
|
|
|
## Issue Reporting
|
|
Make suggestions or report issues using the Git issue tracker: https://github.com/Masterminds/goutils/issues
|
|
|
|
## Website
|
|
* [GoUtils webpage](http://Masterminds.github.io/goutils/)
|