search

blake-mealey / openapi-review-action

A GitHub action that posts your OpenAPI docs as a comment to your PR whenever they change.
MIT License
2 stars 0 forks source link

Add notifier to documentation when changes are detected within an operation #17

Closed blake-mealey closed 4 years ago

github-actions[bot] commented 4 years ago

OpenAPI Review

Spec: ./fixtures/api-with-examples.json

OpenAPI Diff

⚡ Powered by openapi-diff

🚨 BREAKING CHANGES 🚨

Change Classification Count
Breaking 1
Non-breaking 1
Unclassified 0
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": [ { "type": "non-breaking", "action": "add", "code": "response.status-code.add", "destinationSpecEntityDetails": [ { "location": "paths./v2.get.responses.400", "value": { "description": "400 response", "content": { "application/json": { "examples": { "bar": { "value": { "error": "BAD REQUEST" } } } } } } } ], "entity": "response.status-code", "source": "openapi-diff", "sourceSpecEntityDetails": [] } ], "unclassifiedDifferences": [] } ```

OpenAPI Docs

⚡ Powered by widdershins

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

⚠ CHANGES ⚠

Docs `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" } ], "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" } ] } } ``` > 400 response ```json { "error": "BAD REQUEST" } ```

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 | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | 400 response | None |

Response Schema

blake-mealey commented 4 years ago

Resolves #16