Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions generator/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ module github.com/oasdiff/openapi-changes-model/generator
go 1.26.2

require (
github.com/oasdiff/oasdiff v1.34.0
github.com/oasdiff/oasdiff v1.35.0
gopkg.in/yaml.v3 v3.0.1
)

require (
cloud.google.com/go v0.123.0 // indirect
github.com/TwiN/go-color v1.4.1 // indirect
github.com/getkin/kin-openapi v0.149.0 // indirect
github.com/getkin/kin-openapi v0.151.0 // indirect
github.com/go-openapi/jsonpointer v1.0.2 // indirect
github.com/kr/pretty v0.3.1 // indirect
github.com/oasdiff/yaml v0.1.1 // indirect
Expand All @@ -22,5 +22,6 @@ require (
github.com/tidwall/sjson v1.2.5 // indirect
github.com/wI2L/jsondiff v0.7.1 // indirect
github.com/yargevad/filepathx v1.0.0 // indirect
go.yaml.in/yaml/v3 v3.0.5 // indirect
golang.org/x/text v0.43.0 // indirect
)
8 changes: 4 additions & 4 deletions generator/go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ github.com/TwiN/go-color v1.4.1/go.mod h1:WcPf/jtiW95WBIsEeY1Lc/b8aaWoiqQpu5cf8W
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
github.com/dlclark/regexp2 v1.11.0 h1:G/nrcoOa7ZXlpoa/91N3X7mM3r8eIlMBBJZvsz/mxKI=
github.com/dlclark/regexp2 v1.11.0/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8=
github.com/getkin/kin-openapi v0.149.0 h1:ZbhmVJ4yq5RZDUsyP8lcBcGMsjsaTqXEFt6isdtMDfA=
github.com/getkin/kin-openapi v0.149.0/go.mod h1:1+BHDzstro+P5CKtPy1X4PfofnFgmRe6uvMy9+r9fKY=
github.com/getkin/kin-openapi v0.151.0 h1:p8NIstL53h620DnlO9R4pR4QRkEzJ3jbw9flb4kc1hg=
github.com/getkin/kin-openapi v0.151.0/go.mod h1:1+BHDzstro+P5CKtPy1X4PfofnFgmRe6uvMy9+r9fKY=
github.com/go-openapi/jsonpointer v1.0.2 h1:NbW7xT2b+l7x+JefiPGDsZWsrLk1ogrz4AHK1TTzMt8=
github.com/go-openapi/jsonpointer v1.0.2/go.mod h1:N0rI4MbNKD7xAFTiHtB+5Nhrg2j/wwYg7m7Fmb4/jk8=
github.com/go-openapi/testify/v2 v2.8.0 h1:19QDx5b57p8KjO2E4sgs/woL4Akp+FGLRlVm2xn0Rho=
Expand All @@ -17,8 +17,8 @@ github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
github.com/oasdiff/oasdiff v1.34.0 h1:loRrQGPm3udYTOlF/xtcVJDdWvR0YQ6l8KhrsZVJWOg=
github.com/oasdiff/oasdiff v1.34.0/go.mod h1:mHvjcoLZn0z1JwJDcXbK3W6Bqcbq/lD2Kw5qCOBOrHA=
github.com/oasdiff/oasdiff v1.35.0 h1:qGblKALpcMETjtPfJfMnsaeATQHRinSgwuFvjOPz8Es=
github.com/oasdiff/oasdiff v1.35.0/go.mod h1:kLaWCIREWZay64/YzhV7i1eQCjTCGbsgE6HkF87x9kg=
github.com/oasdiff/yaml v0.1.1 h1:6nHx+pn9gBRM6YpBlFZFQGCCd1nuvqOBtTD3KKTgGxY=
github.com/oasdiff/yaml v0.1.1/go.mod h1:EYJNoyktvWMJ0Hmhx+6qTaqMOsalUaRGT8Sj1hNcegU=
github.com/oasdiff/yaml3 v0.0.14 h1:aLJee3hxBK2H5wdXd9iPcIXb93Nty1Ge0pT171eHtkw=
Expand Down
166 changes: 106 additions & 60 deletions openapi-changes-model.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# do not edit by hand. See README.md for how to propose a change.
model: OpenAPI Changes Model
version: 0.1.0-draft
generated_from: oasdiff v1.34.0
generated_from: oasdiff v1.35.0
vocabulary:
locations: 'A location is a path through the OpenAPI object model, dot-separated, with * standing in for a name the API author chooses (a path, a method, a media type, a property name) and x-* for a specification extension: paths.*.*.requestBody.content.*.schema.maxLength names the maxLength keyword of any request body schema. A claim is location:action[,action...], the edits a change covers; a claim pattern may use ** to cover a location family.'
actions:
Expand Down Expand Up @@ -457,6 +457,16 @@ changes:
- components.securitySchemes.*.scheme:set,unset,change
description: http authentication scheme modified in components/securitySchemes
message: the component security scheme %s http scheme changed from %s to %s
- id: api-security-component-oauth-refresh-url-changed
level: warning
direction: none
area: security
kind: type
effect: unknown
claims:
- components.securitySchemes.*.flows.**.refreshUrl:set,unset,change
description: refresh URL modified in OAuth flow in components/securitySchemes
message: the component security scheme %s oauth %s flow refresh url changed from %s to %s
- id: api-security-component-oauth-scope-added
level: info
direction: none
Expand All @@ -466,7 +476,7 @@ changes:
claims:
- components.securitySchemes.*.flows.**.scopes.*:add
description: scope added to OAuth flow in components/securitySchemes
message: the component security scheme %s oauth scope %s was added
message: the component security scheme %s oauth %s flow scope %s was added
- id: api-security-component-oauth-scope-changed
level: info
direction: none
Expand All @@ -476,7 +486,7 @@ changes:
claims:
- components.securitySchemes.*.flows.**.scopes.*:change
description: scope modified in OAuth flow in components/securitySchemes
message: the component security scheme %s oauth scope %s was updated from %s to %s
message: the component security scheme %s oauth %s flow scope %s was updated from %s to %s
- id: api-security-component-oauth-scope-removed
level: info
direction: none
Expand All @@ -486,33 +496,33 @@ changes:
claims:
- components.securitySchemes.*.flows.**.scopes.*:remove
description: scope deleted from OAuth flow in components/securitySchemes
message: the component security scheme %s oauth scope %s was removed
message: the component security scheme %s oauth %s flow scope %s was removed
- id: api-security-component-oauth-token-url-changed
level: info
level: warning
direction: none
area: security
kind: type
effect: none
effect: unknown
claims:
- components.securitySchemes.*.flows.**.tokenUrl:set,unset,change
description: token URL modified in OAuth flow in components/securitySchemes
message: the component security scheme %s oauth token url changed from %s to %s
message: the component security scheme %s oauth %s flow token url changed from %s to %s
- id: api-security-component-oauth-url-changed
level: info
level: warning
direction: none
area: security
kind: type
effect: none
effect: unknown
claims:
- components.securitySchemes.*.flows.**.authorizationUrl:set,unset,change
description: auth URL modified in OAuth flow in components/securitySchemes
message: the component security scheme %s oauth url changed from %s to %s
message: the component security scheme %s oauth %s flow authorization url changed from %s to %s
- id: api-security-component-openid-connect-url-changed
level: error
level: warning
direction: none
area: security
kind: type
effect: incomparable
effect: unknown
claims:
- components.securitySchemes.*.openIdConnectUrl:set,unset,change
description: OpenID Connect url modified in components/securitySchemes
Expand Down Expand Up @@ -4227,6 +4237,28 @@ changes:
- paths.*.*.requestBody.content.*.schema.properties.*:remove
description: request property removed
message: removed the request property %s
- id: request-property-removed-before-sunset
level: error
direction: request
area: schema
kind: existence
effect: violation
claims:
- paths.*.*.requestBody.content.*.schema.properties.*:remove
description: request property removed before sunset date
message: removed the request property %s before the sunset date %s
- id: request-property-removed-with-deprecation
level: info
direction: request
area: schema
kind: existence
effect: unknown
guards:
- sanctioned
claims:
- paths.*.*.requestBody.content.*.schema.properties.*:remove
description: request property removed after deprecation
message: removed the deprecated request property %s
- id: request-property-schema-became-false
level: error
direction: request
Expand Down Expand Up @@ -7937,6 +7969,28 @@ changes:
- paths.*.*.responses.*.content.*.schema.properties.*:remove
description: response required property removed
message: removed the required property %s from the response with the %s status
- id: response-required-property-removed-before-sunset
level: error
direction: response
area: schema
kind: existence
effect: violation
claims:
- paths.*.*.responses.*.content.*.schema.properties.*:remove
description: response required property removed before sunset date
message: removed the required property %s from the response with the %s status before the sunset date %s
- id: response-required-property-removed-with-deprecation
level: info
direction: response
area: schema
kind: existence
effect: widens
guards:
- sanctioned
claims:
- paths.*.*.responses.*.content.*.schema.properties.*:remove
description: response required property removed after deprecation
message: removed the deprecated required property %s from the response with the %s status
- id: response-required-write-only-property-added
level: info
direction: response
Expand Down Expand Up @@ -51005,24 +51059,21 @@ coverage:
- location: components.securitySchemes.*.flows.authorizationCode.refreshUrl
action: change
polarity: shared
status: waived
category: open
reason: OAuth refresh URL changes have no check
suggestedId: api-security-scheme-refresh-url-changed
status: covered
checks:
- api-security-component-oauth-refresh-url-changed
- location: components.securitySchemes.*.flows.authorizationCode.refreshUrl
action: set
polarity: shared
status: waived
category: open
reason: OAuth refresh URL changes have no check
suggestedId: api-security-scheme-refresh-url-set
status: covered
checks:
- api-security-component-oauth-refresh-url-changed
- location: components.securitySchemes.*.flows.authorizationCode.refreshUrl
action: unset
polarity: shared
status: waived
category: open
reason: OAuth refresh URL changes have no check
suggestedId: api-security-scheme-refresh-url-unset
status: covered
checks:
- api-security-component-oauth-refresh-url-changed
- location: components.securitySchemes.*.flows.authorizationCode.scopes.*
action: add
polarity: shared
Expand Down Expand Up @@ -51121,24 +51172,21 @@ coverage:
- location: components.securitySchemes.*.flows.clientCredentials.refreshUrl
action: change
polarity: shared
status: waived
category: open
reason: OAuth refresh URL changes have no check
suggestedId: api-security-scheme-refresh-url-changed
status: covered
checks:
- api-security-component-oauth-refresh-url-changed
- location: components.securitySchemes.*.flows.clientCredentials.refreshUrl
action: set
polarity: shared
status: waived
category: open
reason: OAuth refresh URL changes have no check
suggestedId: api-security-scheme-refresh-url-set
status: covered
checks:
- api-security-component-oauth-refresh-url-changed
- location: components.securitySchemes.*.flows.clientCredentials.refreshUrl
action: unset
polarity: shared
status: waived
category: open
reason: OAuth refresh URL changes have no check
suggestedId: api-security-scheme-refresh-url-unset
status: covered
checks:
- api-security-component-oauth-refresh-url-changed
- location: components.securitySchemes.*.flows.clientCredentials.scopes.*
action: add
polarity: shared
Expand Down Expand Up @@ -51237,24 +51285,21 @@ coverage:
- location: components.securitySchemes.*.flows.implicit.refreshUrl
action: change
polarity: shared
status: waived
category: open
reason: OAuth refresh URL changes have no check
suggestedId: api-security-scheme-refresh-url-changed
status: covered
checks:
- api-security-component-oauth-refresh-url-changed
- location: components.securitySchemes.*.flows.implicit.refreshUrl
action: set
polarity: shared
status: waived
category: open
reason: OAuth refresh URL changes have no check
suggestedId: api-security-scheme-refresh-url-set
status: covered
checks:
- api-security-component-oauth-refresh-url-changed
- location: components.securitySchemes.*.flows.implicit.refreshUrl
action: unset
polarity: shared
status: waived
category: open
reason: OAuth refresh URL changes have no check
suggestedId: api-security-scheme-refresh-url-unset
status: covered
checks:
- api-security-component-oauth-refresh-url-changed
- location: components.securitySchemes.*.flows.implicit.scopes.*
action: add
polarity: shared
Expand Down Expand Up @@ -51353,24 +51398,21 @@ coverage:
- location: components.securitySchemes.*.flows.password.refreshUrl
action: change
polarity: shared
status: waived
category: open
reason: OAuth refresh URL changes have no check
suggestedId: api-security-scheme-refresh-url-changed
status: covered
checks:
- api-security-component-oauth-refresh-url-changed
- location: components.securitySchemes.*.flows.password.refreshUrl
action: set
polarity: shared
status: waived
category: open
reason: OAuth refresh URL changes have no check
suggestedId: api-security-scheme-refresh-url-set
status: covered
checks:
- api-security-component-oauth-refresh-url-changed
- location: components.securitySchemes.*.flows.password.refreshUrl
action: unset
polarity: shared
status: waived
category: open
reason: OAuth refresh URL changes have no check
suggestedId: api-security-scheme-refresh-url-unset
status: covered
checks:
- api-security-component-oauth-refresh-url-changed
- location: components.securitySchemes.*.flows.password.scopes.*
action: add
polarity: shared
Expand Down Expand Up @@ -60778,6 +60820,8 @@ coverage:
status: covered
checks:
- request-property-removed
- request-property-removed-before-sunset
- request-property-removed-with-deprecation
- location: paths.*.*.requestBody.content.*.schema.propertyNames
action: set
polarity: request
Expand Down Expand Up @@ -65381,6 +65425,8 @@ coverage:
- response-optional-property-removed
- response-optional-write-only-property-removed
- response-required-property-removed
- response-required-property-removed-before-sunset
- response-required-property-removed-with-deprecation
- response-required-write-only-property-removed
- location: paths.*.*.responses.*.content.*.schema.propertyNames
action: set
Expand Down
Loading