github-actions[bot]
commented
4 years ago OpenAPI Review Action
Spec: ./fixtures/api-with-examples.json
OpenAPI Diff
🚨 BREAKING CHANGES 🚨
- Breaking changes: 1
- Non-breaking changes: 0
- Unclassified changes: 0
OpenAPI Review Action
OpenAPI Diff
🚨 BREAKING CHANGES 🚨
Diff
```json { "breakingDifferences": [ { "type": "breaking", "action": "remove", "code": "response.status-code.remove", "destinationSpecEntityDetails": [], "entity": "response.status-code", "source": "openapi-diff", "sourceSpecEntityDetails": [ { "location": "paths./.get.responses.200", "value": { "description": "200 response", "content": { "application/json": { "examples": { "foo": { "value": { "versions": [ { "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "id": "v2.0", "links": [ { "href": "http://127.0.0.1:8774/v2/", "rel": "self" } ] }, { "updated": "2013-07-23T11:33:21Z", "id": "v3.0", "links": [ { "href": "http://127.0.0.1:8774/v3/", "rel": "self" } ] } ] } } } } } } } ] } ], "breakingDifferencesFound": true, "nonBreakingDifferences": [], "unclassifiedDifferences": [] } ```List API versions
🚨 BREAKING CHANGES 🚨
Docs
`GET /` > Example responses > 300 response ```json { "versions": [ { "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "id": "v2.0", "links": [ { "href": "http://127.0.0.1:8774/v2/", "rel": "self" } ] }, { "status": "EXPERIMENTAL", "updated": "2013-07-23T11:33:21Z", "id": "v3.0", "links": [ { "href": "http://127.0.0.1:8774/v3/", "rel": "self" } ] } ] } ```Responses
| Status | Meaning | Description | Schema | | ------ | --------------------------------------------------------------------- | ------------ | ------ | | 300 | [Multiple Choices](https://tools.ietf.org/html/rfc7231#section-6.4.1) | 300 response | None |Response Schema
Show API version details
🚨 BREAKING CHANGES 🚨
Documentation:
`GET /v2` > Example responses > 200 response ```json { "version": { "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "media-types": [ { "base": "application/xml", "type": "application/vnd.openstack.compute+xml;version=2" }, { "base": "application/json", "type": "application/vnd.openstack.compute+json;version=2" }, { "base": "application/json", "type": "application/vnd.openstack.compute+json;version=3" } ], "id": "v2.0", "links": [ { "href": "http://127.0.0.1:8774/v2/", "rel": "self" }, { "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", "type": "application/pdf", "rel": "describedby" }, { "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", "type": "application/vnd.sun.wadl+xml", "rel": "describedby" }, { "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", "type": "application/vnd.sun.wadl+xml", "rel": "describedby" } ] } } ``` > 203 response ```json { "version": { "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "media-types": [ { "base": "application/xml", "type": "application/vnd.openstack.compute+xml;version=2" }, { "base": "application/json", "type": "application/vnd.openstack.compute+json;version=2" } ], "id": "v2.0", "links": [ { "href": "http://23.253.228.211:8774/v2/", "rel": "self" }, { "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", "type": "application/pdf", "rel": "describedby" }, { "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", "type": "application/vnd.sun.wadl+xml", "rel": "describedby" } ] } } ```Responses
| Status | Meaning | Description | Schema | | ------ | ---------------------------------------------------------------------------------- | ------------ | ------ | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 200 response | None | | 203 | [Non-Authoritative Information](https://tools.ietf.org/html/rfc7231#section-6.3.4) | 203 response | None |Response Schema