mirrors/gotosocial
1
0
Fork 0
mirror of https://codeberg.org/superseriousbusiness/gotosocial.git synced 2024-12-21 08:31:53 +03:00
Code Issues Projects Releases Packages Wiki Activity
gotosocial/vendor/github.com/go-openapi/analysis/README.md
Vyr Cossont fc3741365c
[bugfix] Fix Swagger spec and add test script (#2698) 
* 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>
2024-03-06 18:05:45 +01:00

1.7 KiB
Raw Blame History

OpenAPI initiative analysis

Build Status Build status codecov Slack Status license Go Reference Go Report Card

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 $refs
  • A spec merger ("mixin") to merge several spec documents into a primary spec
  • A spec "fixer" ensuring that response descriptions are non empty

Documentation

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 relates the full story.