feat: adds additional operations for path item object by baywet · Pull Request #4514 · OAI/OpenAPI-Specification

baywet · 2025-03-28T12:55:42Z

fixes #1747

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

ralfhandl

Could you please add a failing test case trying to use "GET" as an additional operation?

Co-authored-by: Ralf Handl <ralf.handl@sap.com>

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

…ent object Signed-off-by: Vincent Biret <vibiret@microsoft.com>

baywet · 2025-03-28T14:25:19Z

Could you please add a failing test case trying to use "GET" as an additional operation?

done. I added POST instead to make it clear that it's not just a collision with what's defined in the document, but rather a matter of "where things should go".

Co-authored-by: Ralf Handl <ralf.handl@sap.com>

handrews · 2025-03-29T15:31:17Z

@baywet @kevinswiber I did not see a reply in the issue to my idea that we include query among the special-cased fields rather than relegating it to additionalOperations, since it is on the verge of becoming an IANA-registered general-purpose (non-WebDAV) HTTP method. I would prefer that approach.

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

baywet · 2025-03-31T13:05:11Z

@baywet @kevinswiber I did not see a reply in the issue to my idea that we include query among the special-cased fields rather than relegating it to additionalOperations, since it is on the verge of becoming an IANA-registered general-purpose (non-WebDAV) HTTP method. I would prefer that approach.

I don't have a strong preference either way. If it's about to be a "well known" method/verb, I think it makes sense to hoist it. Added it (push soon).

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

Co-authored-by: Henry Andrews <andrews_henry@yahoo.com>

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

Co-authored-by: Henry Andrews <andrews_henry@yahoo.com>

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

handrews

Thanks for catching and fixing my copy-paste error!

Co-authored-by: Ethan <133719+notEthan@users.noreply.github.com>

baywet · 2025-04-01T12:20:29Z

@ralfhandl for a final review/approval/merge with the latest minor edits

ralfhandl

+1, just one typo and one omission

Co-authored-by: Ralf Handl <ralf.handl@sap.com>

feat: adds additional operations for path item object

701d460

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

baywet requested review from a team as code owners March 28, 2025 12:55

baywet mentioned this pull request Mar 28, 2025

Support all HTTP Methods #1747

Closed

33 tasks

baywet added 4 commits March 28, 2025 08:58

chore: adds test data for additional operations

524cc6f

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

fix: schema definition for outlawed properties

b12f34b

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

fix: schema indentation and adds required keyword

692b413

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

fix: 🤦 vincent needs a coffee

62dbf31

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

baywet mentioned this pull request Mar 28, 2025

Open Community (TDC) Meeting, Thursday 03 April 2025 #4508

Closed

ralfhandl reviewed Mar 28, 2025

View reviewed changes

Comment thread tests/schema/pass/path-item-object-example.yaml Outdated

Comment thread src/oas.md Outdated

Comment thread src/oas.md Outdated

Comment thread src/oas.md Outdated

baywet and others added 3 commits March 28, 2025 10:21

Apply suggestions from code review

15e99ca

Co-authored-by: Ralf Handl <ralf.handl@sap.com>

Update tests/schema/pass/path-item-object-example.yaml

72a29d7

Co-authored-by: Ralf Handl <ralf.handl@sap.com>

chore: moves additional operations after the defined operations

2452ad1

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

baywet requested a review from ralfhandl March 28, 2025 14:23

ci: adds a failing test for methods that should be defined on the par…

4cf5168

…ent object Signed-off-by: Vincent Biret <vibiret@microsoft.com>

ralfhandl reviewed Mar 28, 2025

View reviewed changes

Comment thread tests/schema/fail/path-item-object-example.yaml

ralfhandl requested changes Mar 28, 2025

View reviewed changes

Comment thread tests/schema/fail/path-item-object-example.yaml Outdated

Comment thread src/schemas/validation/schema.yaml Outdated

Update tests/schema/fail/path-item-object-example.yaml

cfdc4bc

Co-authored-by: Ralf Handl <ralf.handl@sap.com>

notEthan reviewed Mar 29, 2025

View reviewed changes

Comment thread src/schemas/validation/schema.yaml Outdated

ralfhandl reviewed Mar 29, 2025

View reviewed changes

Comment thread src/schemas/validation/schema.yaml Outdated

handrews reviewed Mar 29, 2025

View reviewed changes

Comment thread src/schemas/validation/schema.yaml Outdated

handrews requested changes Mar 29, 2025

View reviewed changes

Comment thread src/oas.md Outdated

baywet added 2 commits March 31, 2025 09:03

chore: renames fail file to have more explicit definition of the case

d5141ec

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

feat: adds query as "principal" operation type in path item

6ed7fe8

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

baywet and others added 3 commits March 31, 2025 09:09

fix: excluded operations filter for additional operations

61fee04

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

docs: updates wording for additional operations exclusions

d3c477c

Co-authored-by: Henry Andrews <andrews_henry@yahoo.com>

docs: updates additional operation samples to match hoisting of query

2dc3e06

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

baywet dismissed ralfhandl’s stale review via 9a53a9d March 31, 2025 18:08

docs: adds the query method to the spec

621d1c3

Co-authored-by: Henry Andrews <andrews_henry@yahoo.com>

baywet requested review from handrews and ralfhandl March 31, 2025 18:09

fix: tchar definition

ed5cfe4

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

handrews previously approved these changes Mar 31, 2025

View reviewed changes

notEthan reviewed Mar 31, 2025

View reviewed changes

Comment thread src/schemas/validation/schema.yaml Outdated

notEthan reviewed Mar 31, 2025

View reviewed changes

Comment thread src/schemas/validation/schema.yaml

Fix regex character class

480dc75

Co-authored-by: Ethan <133719+notEthan@users.noreply.github.com>

handrews dismissed their stale review via 480dc75 March 31, 2025 19:29

handrews reviewed Mar 31, 2025

View reviewed changes

Comment thread src/schemas/validation/schema.yaml Outdated

Fix character class in regular expression

1826161

handrews reviewed Mar 31, 2025

View reviewed changes

Comment thread src/schemas/validation/schema.yaml Outdated

Undo my incorrect additional "fix"

3ee2d24

handrews previously approved these changes Mar 31, 2025

View reviewed changes

notEthan approved these changes Mar 31, 2025

View reviewed changes

ralfhandl requested changes Apr 1, 2025

View reviewed changes

Comment thread src/oas.md Outdated

Comment thread src/schemas/validation/schema.yaml Outdated

docs: typo fix in html attribute name

0c4f6be

Co-authored-by: Ralf Handl <ralf.handl@sap.com>

baywet dismissed handrews’s stale review via 0c4f6be April 1, 2025 12:57

docs: schema regex fix

238aaca

Co-authored-by: Ralf Handl <ralf.handl@sap.com>

baywet requested review from handrews and ralfhandl April 1, 2025 12:57

ralfhandl approved these changes Apr 1, 2025

View reviewed changes

ralfhandl requested a review from a team April 1, 2025 13:12

handrews approved these changes Apr 1, 2025

View reviewed changes

ralfhandl merged commit 7b29ee4 into OAI:v3.2-dev Apr 1, 2025
2 checks passed

baywet deleted the feat/additional-operations branch April 1, 2025 17:34

karenetheridge mentioned this pull request Apr 3, 2025

3.2: support additionalOperations karenetheridge/OpenAPI-Modern#91

Closed

BrentWilkins mentioned this pull request Sep 2, 2025

Will FastAPI support QUERY http method? "app.query" fastapi/fastapi#12965

Closed

9 tasks

Conversation

baywet commented Mar 28, 2025

Uh oh!

ralfhandl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

baywet commented Mar 28, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

handrews commented Mar 29, 2025

Uh oh!

Uh oh!

Uh oh!

baywet commented Mar 31, 2025

Uh oh!

handrews left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

baywet commented Apr 1, 2025

Uh oh!

ralfhandl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants