gotosocial/vendor/github.com/go-openapi/spec/README.md

# OpenAPI v2 object model [![Build Status](https://github.com/go-openapi/spec/actions/workflows/go-test.yml/badge.svg)](https://github.com/go-openapi/spec/actions?query=workflow%3A"go+test") [![codecov](https://codecov.io/gh/go-openapi/spec/branch/master/graph/badge.svg)](https://codecov.io/gh/go-openapi/spec)

[![Slack Status](https://slackin.goswagger.io/badge.svg)](https://slackin.goswagger.io)
[![license](http://img.shields.io/badge/license-Apache%20v2-orange.svg)](https://raw.githubusercontent.com/go-openapi/spec/master/LICENSE)
[![Go Reference](https://pkg.go.dev/badge/github.com/go-openapi/spec.svg)](https://pkg.go.dev/github.com/go-openapi/spec)
[![Go Report Card](https://goreportcard.com/badge/github.com/go-openapi/spec)](https://goreportcard.com/report/github.com/go-openapi/spec)

The object model for OpenAPI specification documents.

### FAQ

* What does this do?

> 1. This package knows how to marshal and unmarshal Swagger API specifications into a golang object model
> 2. 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 ?

> 1. This package is at the core of the go-openapi suite of packages and [code generator](https://github.com/go-swagger/go-swagger)
> 2. There is a [spec loading package](https://github.com/go-openapi/loads) to fetch specs as JSON or YAML from local or remote locations
> 3. There is a [spec validation package](https://github.com/go-openapi/validate) built on top of it
> 4. There is a [spec analysis package](https://github.com/go-openapi/analysis) 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](https://github.com/go-openapi/spec/issues/21) relates the full story.
>
> An early attempt to support Swagger 3 may be found at: https://github.com/go-openapi/spec3

* Does the unmarshaling support YAML?

> Not directly. The exposed types know only how to unmarshal from JSON.
>
> In order to load a YAML document as a Swagger spec, you need to use the loaders provided by
> github.com/go-openapi/loads
>
> Take a look at the example there: https://pkg.go.dev/github.com/go-openapi/loads#example-Spec
>
> See also https://github.com/go-openapi/spec/issues/164

* How can I validate a spec?

> Validation is provided by [the validate package](http://github.com/go-openapi/validate)

* Why do we have an `ID` field for `Schema` which is not part of the swagger spec?

> We found jsonschema compatibility more important: since `id` in jsonschema influences
> how `$ref` are resolved.
> This `id` does not conflict with any property named `id`.
>
> See also https://github.com/go-openapi/spec/issues/23
[chore] Bump go swagger (#2871) * bump go swagger version * bump swagger version 2024-04-26 10:31:10 +01:00			`# OpenAPI v2 object model [![Build Status](https://github.com/go-openapi/spec/actions/workflows/go-test.yml/badge.svg)](https://github.com/go-openapi/spec/actions?query=workflow%3A"go+test") [![codecov](https://codecov.io/gh/go-openapi/spec/branch/master/graph/badge.svg)](https://codecov.io/gh/go-openapi/spec)`
[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 17:05:45 +00:00
			`[![Slack Status](https://slackin.goswagger.io/badge.svg)](https://slackin.goswagger.io)`
			`[![license](http://img.shields.io/badge/license-Apache%20v2-orange.svg)](https://raw.githubusercontent.com/go-openapi/spec/master/LICENSE)`
			`[![Go Reference](https://pkg.go.dev/badge/github.com/go-openapi/spec.svg)](https://pkg.go.dev/github.com/go-openapi/spec)`
			`[![Go Report Card](https://goreportcard.com/badge/github.com/go-openapi/spec)](https://goreportcard.com/report/github.com/go-openapi/spec)`

			`The object model for OpenAPI specification documents.`

			`### FAQ`

			`* What does this do?`

			`> 1. This package knows how to marshal and unmarshal Swagger API specifications into a golang object model`
			`> 2. 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 ?`

			`> 1. This package is at the core of the go-openapi suite of packages and [code generator](https://github.com/go-swagger/go-swagger)`
			`> 2. There is a [spec loading package](https://github.com/go-openapi/loads) to fetch specs as JSON or YAML from local or remote locations`
			`> 3. There is a [spec validation package](https://github.com/go-openapi/validate) built on top of it`
			`> 4. There is a [spec analysis package](https://github.com/go-openapi/analysis) 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](https://github.com/go-openapi/spec/issues/21) relates the full story.`
			`>`
			`> An early attempt to support Swagger 3 may be found at: https://github.com/go-openapi/spec3`
[chore] Bump go swagger (#2871) * bump go swagger version * bump swagger version 2024-04-26 10:31:10 +01:00
			`* Does the unmarshaling support YAML?`

			`> Not directly. The exposed types know only how to unmarshal from JSON.`
			`>`
			`> In order to load a YAML document as a Swagger spec, you need to use the loaders provided by`
			`> github.com/go-openapi/loads`
			`>`
			`> Take a look at the example there: https://pkg.go.dev/github.com/go-openapi/loads#example-Spec`
			`>`
			`> See also https://github.com/go-openapi/spec/issues/164`

			`* How can I validate a spec?`

			`> Validation is provided by [the validate package](http://github.com/go-openapi/validate)`

			* Why do we have an `ID` field for `Schema` which is not part of the swagger spec?

			> We found jsonschema compatibility more important: since `id` in jsonschema influences
			> how `$ref` are resolved.
			> This `id` does not conflict with any property named `id`.
			`>`
			`> See also https://github.com/go-openapi/spec/issues/23`