Skip to content

Conversation

@le-cong
Copy link

@le-cong le-cong commented Oct 1, 2025

Fixes #23

@le-cong le-cong self-assigned this Oct 1, 2025
@le-cong le-cong added the MINOR label Oct 1, 2025
Copilot AI review requested due to automatic review settings October 1, 2025 21:34
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Purpose: Make operationId optional by disabling its enforcing rule, updating example spec and documentation, and bumping package/dependency versions while updating supported Node.js versions.

  • Disable operation-operationId rule (make operationId optional) and adjust test fixture.
  • Remove corresponding documentation; bump package version and update dependencies / Node versions.
  • Update CI and publish workflows to test/use Node 24.x.

Reviewed Changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
test/openapi.yml Removed sample operationId to reflect new optional status.
ruleset.json Disabled operation-operationId rule while keeping related validation rule.
package.json Bumped version to 3.1.0; updated prettier config, spectral peer dep, and Node engine.
README.md Removed guidance about mandatory operationId (left an empty section header).
.github/workflows/publish.yml Switched runtime to Node 24.x.
.github/workflows/publish-beta.yml Switched runtime to Node 24.x.
.github/workflows/ci.yml Replaced Node 23.x matrix entry with 24.x.
.github/workflows/check-published-scheduled.yml Switched runtime to Node 24.x.

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link
Contributor

@ramaghanta ramaghanta left a comment

Choose a reason for hiding this comment

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

lftm

Copy link
Contributor

@carlansley carlansley left a comment

Choose a reason for hiding this comment

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

node bump, but otherwise lgtm

package.json Outdated
},
"engines": {
"node": ">=22.11"
"node": ">=22.15"
Copy link
Contributor

Choose a reason for hiding this comment

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

22.18

@le-cong le-cong requested a review from carlansley October 2, 2025 21:19
@lukebrdn
Copy link
Contributor

lukebrdn commented Oct 6, 2025

I'm not sure we want to make this value optional. Its primary use is to help OAS visualizers, and other tooling, uniquely identify and reference operations. Making them optional sort of kills that use case. I'd vote for keeping them required since it's recommended by Spectral and all of our APIs already include them. That said, if we want to remove them I think we should just outright ban them.

Copy link

@bobwieler bobwieler left a comment

Choose a reason for hiding this comment

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

i agree with @lukebrdn in that i don't think we want to make this optional. i've never found setting the operation id to be an issue until we started using typespec and with that gone i'd rather have this be explicit.

Copilot AI review requested due to automatic review settings October 6, 2025 19:03
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 8 out of 9 changed files in this pull request and generated 4 comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copilot AI review requested due to automatic review settings October 6, 2025 19:46
@le-cong le-cong added MAJOR and removed MINOR labels Oct 6, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 8 out of 9 changed files in this pull request and generated 6 comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@le-cong le-cong requested review from bobwieler and Copilot October 6, 2025 19:48
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 8 out of 9 changed files in this pull request and generated 1 comment.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@le-cong
Copy link
Author

le-cong commented Oct 6, 2025

following the comments from @lukebrdn and @bobwieler, we are now disallowing operationId field completely (error will be reported if used). since it'll be a breaking change, we are bumping it to a MAJOR version and re-requesting approvals for everyone. thanks!

@le-cong le-cong requested a review from lukebrdn October 6, 2025 19:59
@github-actions
Copy link

github-actions bot commented Oct 6, 2025

❌ PR review status - has 3 reviewers outstanding

@github-actions
Copy link

github-actions bot commented Oct 6, 2025

Beta Published - Install Command: npm install @checkdigit/spectral-config@4.0.0-PR.24-4dc5

@le-cong le-cong changed the title make operationId optional disallow operationId Oct 7, 2025
@le-cong
Copy link
Author

le-cong commented Oct 7, 2025

we'll keep operationId to be explicit and avoid auto-generating stuff. so closing the PR.

@le-cong le-cong closed this Oct 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

disallow operationId

6 participants