Skip to content

Make PathItem operation properties specific - #2127

Merged
webron merged 1 commit into
OAI:mainfrom
axelcostaspena:specific-pathItem-operations
Mar 27, 2022
Merged

Make PathItem operation properties specific#2127
webron merged 1 commit into
OAI:mainfrom
axelcostaspena:specific-pathItem-operations

Conversation

@axelcostaspena

@axelcostaspenaaxelcostaspena commented Feb 5, 2020

Copy link
Copy Markdown
Contributor

PR for #2126.

Move the Operations properties definitions from patternProperties to the properties set, explicitly defining all of them. The goal is to get better coding tools completion - IntelliJ IDEA does - and to improve the spec quality with a purer spec schema usage.

Changes are 100% backwards compatible, all validating schemas will validate and all non validating schemas won't validate after merge. After merge, coding tools will get more information because of replacing a pattern with a defined literal set.

@handrews

handrews commented Feb 5, 2020

Copy link
Copy Markdown
Member

As the primary author of recent drafts of the JSON Schema spec, this is not an abuse of patternProperties. It's certainly valid to talk about what is most useful for tools, but it's a valid and useful technique as written.

@axelcostaspena

axelcostaspena commented Feb 5, 2020

Copy link
Copy Markdown
ContributorAuthor

@handrews your opinion is welcome :)

Never mind, #2126 specifically states that its nº 1 goal is better tool support. Also, commit message first line is about specificity.

@philsturgeonphilsturgeon mentioned this pull request Feb 6, 2020
Closed
MikeRalphson
MikeRalphson approved these changes Feb 6, 2020
View reviewed changes

@MikeRalphsonMikeRalphson left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aye from me.

MikeRalphson
MikeRalphson suggested changes Feb 7, 2020
View reviewed changes

@MikeRalphsonMikeRalphson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Danger Will Robinson! This PR is against the OpenAPI.next branch. I do not believe any merges are scheduled from this branch. @webron please advise correct branch (and maybe we can remove OpenAPI.next?

@axelcostaspena

axelcostaspena commented Feb 7, 2020

Copy link
Copy Markdown
ContributorAuthor

@MikeRalphson hmm sorry! Issue sems worse since the modification comes FROM OpenApi.next, which is unmerged into master. So let me solve it, I will create proper PR. But which work branch to choose? DEVELOPMENT.md:47 and README.md:24 seem to tell me to use 3.1.0-dev - non breaking change - instead of 3.0.3-dev - typos or clarifications - but none of that branch contain the v3 schema ¿?

@MikeRalphson

MikeRalphson commented Feb 7, 2020

Copy link
Copy Markdown
Member

That guidance is for changes to the specification. The schema is non-normative, so I think master should be OK.

@handrewshandrews added the Schema changes related to the schema(s) label Feb 7, 2020
@axelcostaspena
Make PathItem operation properties specific.
9efdced
Avoid misuse of `patternProperties` feature.
FixOAI#2126
@axelcostaspena
axelcostaspenaforce-pushed the specific-pathItem-operations branch from 599549e to 9efdcedCompareFebruary 7, 2020 17:22
@axelcostaspena
axelcostaspena changed the base branch from OpenAPI.next to masterFebruary 7, 2020 17:23
@axelcostaspena

axelcostaspena commented Feb 7, 2020

Copy link
Copy Markdown
ContributorAuthor

@MikeRalphson PR source force updated
PR target updated.
Thank you for support on this.

MikeRalphson
MikeRalphson approved these changes Feb 7, 2020
View reviewed changes

@MikeRalphsonMikeRalphson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aye from me. Thanks for rebasing.

@MikeRalphsonMikeRalphson mentioned this pull request Jun 2, 2020
Closed
@webron
webron merged commit 733c879 into OAI:mainMar 27, 2022
@karenetheridge

karenetheridge commented Mar 28, 2022

Copy link
Copy Markdown
Member

Should this also be merged into v3.1/schema*, as the same keyword usage exists there?

@webron

webron commented Mar 28, 2022

Copy link
Copy Markdown
Member

Wouldn't hurt...

karenetheridge added a commit to karenetheridge/OpenAPI-Specification that referenced this pull request Sep 11, 2022
@karenetheridge
Make PathItem operation properties specific.
d84b34e
(port of PR OAI#2127 to v3.1)
@karenetheridgekarenetheridge mentioned this pull request Sep 11, 2022
Merged
karenetheridge added a commit to karenetheridge/OpenAPI-Specification that referenced this pull request Sep 11, 2022
@karenetheridge
Make PathItem operation properties specific.
e4bf4bb
(port of PR OAI#2127 to v3.2)
@karenetheridgekarenetheridge mentioned this pull request Sep 11, 2022
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@darrelmillerdarrelmillerdarrelmiller approved these changes
@webronwebronAwaiting requested review from webron
+1 more reviewer
@MikeRalphsonMikeRalphsonMikeRalphson approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@webronwebron

Labels

Schemachanges related to the schema(s)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@axelcostaspena@handrews@MikeRalphson@karenetheridge@webron@darrelmiller