mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-11-27 14:16:39 +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>
2.1 KiB
2.1 KiB
OAI object model
The object model for OpenAPI specification documents.
FAQ
- What does this do?
- This package knows how to marshal and unmarshal Swagger API specifications into a golang object model
- It knows how to resolve $ref and expand them to make a single root document
- How does it play with the rest of the go-openapi packages ?
- This package is at the core of the go-openapi suite of packages and code generator
- There is a spec loading package to fetch specs as JSON or YAML from local or remote locations
- There is a spec validation package built on top of it
- There is a spec analysis package built on top of it, to analyze, flatten, fix and merge spec documents
- 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 relates the full story.
An early attempt to support Swagger 3 may be found at: https://github.com/go-openapi/spec3