mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-07-02 03:45:47 +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>
32 lines
1.7 KiB
Markdown
32 lines
1.7 KiB
Markdown
# OpenAPI initiative analysis
|
|
|
|
[](https://travis-ci.org/go-openapi/analysis)
|
|
[](https://ci.appveyor.com/project/casualjim/go-openapi/analysis/branch/master)
|
|
[](https://codecov.io/gh/go-openapi/analysis)
|
|
[](https://slackin.goswagger.io)
|
|
[](https://raw.githubusercontent.com/go-openapi/analysis/master/LICENSE)
|
|
[](https://pkg.go.dev/github.com/go-openapi/analysis)
|
|
[](https://goreportcard.com/report/github.com/go-openapi/analysis)
|
|
|
|
|
|
A foundational library to analyze an OAI specification document for easier reasoning about the content.
|
|
|
|
## What's inside?
|
|
|
|
* A analyzer providing methods to walk the functional content of a specification
|
|
* A spec flattener producing a self-contained document bundle, while preserving `$ref`s
|
|
* A spec merger ("mixin") to merge several spec documents into a primary spec
|
|
* A spec "fixer" ensuring that response descriptions are non empty
|
|
|
|
[Documentation](https://godoc.org/github.com/go-openapi/analysis)
|
|
|
|
## FAQ
|
|
|
|
* Does this library support OpenAPI 3?
|
|
|
|
> No.
|
|
> This package currently only supports OpenAPI 2.0 (aka Swagger 2.0).
|
|
> There is no plan to make it evolve toward supporting OpenAPI 3.x.
|
|
> This [discussion thread](https://github.com/go-openapi/spec/issues/21) relates the full story.
|
|
>
|