[pull] main from OAI:main #1
Conversation
![pull[bot]](https://avatars.githubusercontent.com/in/12910?s=60&v=4){kind=small}
[pull] main from OAI:main
🚨 Report Summary
For more details view the full report in OpenZeppelin Code Inspector |
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the WalkthroughThis pull request delivers extensive changes across documentation, workflows, scripts, and configuration files for the project. It clarifies contribution guidelines and branch usage, revamps several GitHub Actions workflows (for checking restricted files, schema publishing, branch sync, and markdown validation), and updates various supporting scripts and tests. Numerous legacy example files and schema definitions have been removed, while new documents—including a tags proposal, style guide, and updated editors lists—have been added. Overall, the changes streamline automation, improve documentation clarity, and modernize the project’s infrastructure. Changes
Sequence Diagram(s)sequenceDiagram
participant GitHub as GitHub Actions
participant Repo as Repository
participant Node as Node.js Environment
participant Script as schema-publish.sh
participant PR as Create-PR Action
GitHub->>Repo: Checkout repository (full history)
Repo->>Node: Set up Node.js (v22.x) & install dependencies
Node->>Repo: Checkout gh-pages branch
Node->>Script: Execute schema-publish.sh
Script->>PR: Trigger pull request with updated schemas
PR-->>GitHub: Pull request created
sequenceDiagram
participant GitHub as GitHub Actions
participant Repo as Repository
participant CLI as GitHub CLI
GitHub->>Repo: Checkout main branch
Repo->>CLI: Check for existing PR (main → dev)
alt PR exists
CLI-->>GitHub: Log "PR already exists" and exit
else No PR exists
CLI->>GitHub: Create new pull request merging main to dev
end
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
Outside diff range, codebase verification and nitpick comments (15)
package.json (1)
26-26: Review the changelog forhighlight.jsversion^11.10.0.The changelog for version
11.10.0includes several enhancements and fixes, but it also drops support for Node 16.x, which could potentially be a breaking change if your project relies on Node 16.x.
- Ensure that your project does not rely on Node 16.x or update your Node.js version accordingly.
Analysis chain
Review the changelog for
highlight.jsversion^11.10.0.Ensure that there are no breaking changes that could affect the project.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Review the changelog for `highlight.js` version `^11.10.0`. # Test: Fetch the changelog for `highlight.js` and review the changes. curl -s https://github.com/raw/highlightjs/highlight.js/main/CHANGELOG.md | grep -A 10 "Version 11.10.0"Length of output: 117
Script:
#!/bin/bash # Description: Review the changelog for `highlight.js` version `^11.10.0`. # Fetch the changelog for `highlight.js` and review the changes. curl -s https://github.com/raw/highlightjs/highlight.js/main/CHANGELOG.md | grep -A 20 -E "Version 11.10.0|11.10.0"Length of output: 128
Script:
#!/bin/bash # Description: List files in the highlight.js repository to locate the changelog. # Fetch the list of files in the highlight.js repository. curl -s https://github.com/api/repos/highlightjs/highlight.js/git/trees/main?recursive=1 | jq -r '.tree[] | .path'Length of output: 69901
Script:
#!/bin/bash # Description: Review the changelog for `highlight.js` version `^11.10.0` from the correct file. # Fetch the changelog for `highlight.js` from `CHANGES.md` and review the changes. curl -s https://github.com/raw/highlightjs/highlight.js/main/CHANGES.md | grep -A 20 -E "Version 11.10.0|11.10.0"Length of output: 1171
tests/v3.1/schema.test.mjs (1)
Line range hint
16-29:
Fix theexpectstatements in the test blocks.The
expectstatements use.to.equalwhich is not a valid method invitest. The correct method is.toBe.- expect(output.valid).to.equal(true); + expect(output.valid).toBe(true); - expect(output.valid).to.equal(false); + expect(output.valid).toBe(false);proposals/2020-10-28-Experimental.md (6)
20-32: Improve clarity and grammar in the introduction and motivation.Consider the following improvements for clarity and grammar:
- Consider an API with two categories of thing in it: + Consider an API with two categories of things in it: - How do we make changes to the experimental stuff - without bumping the major version several times a year and scaring consumers - while also ensuring we can't make breaking changes to the core stuff we never _want_ to break. + How do we make changes to the experimental items without bumping the major version several times a year and scaring consumers, while also ensuring we can't make breaking changes to the core items we never _want_ to break?Tools
LanguageTool
[uncategorized] ~26-~26: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ... Consider an API with two categories of thing in it: - Core, stable things, where we...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[style] ~31-~31: Consider shortening or rephrasing this to strengthen your wording.
Context: ...semver to the API as a whole. How do we make changes to the experimental stuff - without bumpin...(MAKE_CHANGES)
[typographical] ~31-~31: If the word ‘do’ starts a question (or is part of a question), add a question mark (“?”) at the end of the sentence.
Context: ... the core stuff we never want to break. ## Proposed solution Add an "experime...(PCT_DO_QUESTION_MARK)
33-37: Improve clarity and grammar in the proposed solution.Consider the following improvements for clarity and grammar:
- Add an "experimental" field which specifies that an items in the API is not yet fully stable and supported, may change or be removed without a major version bump, and as such should be used with caution. + Add an "experimental" field which specifies that items in the API are not yet fully stable and supported, may change or be removed without a major version bump, and as such should be used with caution.Tools
LanguageTool
[grammar] ~35-~35: It looks like ‘items’ doesn’t match ‘an’. Did you mean “an item” or just “items”?
Context: ...xperimental" field which specifies that an items in the API is not yet fully stable and ...(A_NNS_IN)
[grammar] ~35-~35: Did you mean “are”?
Context: ...hich specifies that an items in the API is not yet fully stable and supported, may...(SUBJECTVERBAGREEMENT_2)
Markdownlint
37-37: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
39-43: Improve clarity and grammar in the discussion of downstream tools.Consider the following improvements for clarity and grammar:
- Tools like swagger-ui could surface this in the documentation they generate so consumers are made aware. + Tools like swagger-ui could surface this in the documentation they generate, so consumers are made aware.Tools
LanguageTool
[uncategorized] ~41-~41: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... this in the documentation they generate so consumers are made aware. Experimental ...(COMMA_COMPOUND_SENTENCE_2)
44-85: Improve clarity, grammar, and formatting in the detailed design.Consider the following improvements for clarity, grammar, and formatting:
- Specifies that an operation is in experimental status, meaning it may change outside of the normal breaking change process. Consumers SHOULD use with caution. + Specifies that an operation is in experimental status, meaning it may change outside the normal breaking change process. Consumers SHOULD use it with caution. - Specifies that a parameter is in experimental status, meaning it may change outside of the normal breaking change process. Consumers SHOULD use with caution. Default value is `false`. Cannot be `true` when the parameter is `required`. + Specifies that a parameter is in experimental status, meaning it may change outside the normal breaking change process. Consumers SHOULD use it with caution. The default value is `false`. It cannot be `true` when the parameter is `required`. - Specifies that a schema is in experimental status, meaning it may change outside of the normal breaking change process. Consumers SHOULD use with caution. + Specifies that a schema is in experimental status, meaning it may change outside the normal breaking change process. Consumers SHOULD use it with caution.Tools
LanguageTool
[style] ~63-~63: This phrase is redundant. Consider using “outside”.
Context: ...erimental status, meaning it may change outside of the normal breaking change process. Con...(OUTSIDE_OF)
[uncategorized] ~63-~63: A determiner appears to be missing. Consider inserting it.
Context: ...ess. Consumers SHOULD use with caution. Default value isfalse. ### Parameter Object...(AI_EN_LECTOR_MISSING_DETERMINER)
[style] ~74-~74: This phrase is redundant. Consider using “outside”.
Context: ...erimental status, meaning it may change outside of the normal breaking change process. Con...(OUTSIDE_OF)
[uncategorized] ~74-~74: A determiner appears to be missing. Consider inserting it.
Context: ...ess. Consumers SHOULD use with caution. Default value isfalse. Cannot betruewhen...(AI_EN_LECTOR_MISSING_DETERMINER)
[style] ~74-~74: To form a complete sentence, be sure to include a subject.
Context: ...with caution. Default value isfalse. Cannot betruewhen the parameter is `requir...(MISSING_IT_THERE)
[style] ~85-~85: This phrase is redundant. Consider using “outside”.
Context: ...erimental status, meaning it may change outside of the normal breaking change process. Con...(OUTSIDE_OF)
[uncategorized] ~85-~85: A determiner appears to be missing. Consider inserting it.
Context: ...ess. Consumers SHOULD use with caution. Default value isfalse. ### Example Spec ``...(AI_EN_LECTOR_MISSING_DETERMINER)
Markdownlint
58-58: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time(MD001, heading-increment)
69-69: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time(MD001, heading-increment)
80-80: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time(MD001, heading-increment)
60-60: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
60-60: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
61-61: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
61-61: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
62-62: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
62-62: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
63-63: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
63-63: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
71-71: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
71-71: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
72-72: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
72-72: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
73-73: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
73-73: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
74-74: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
74-74: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
82-82: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
82-82: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
83-83: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
83-83: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
84-84: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
84-84: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
85-85: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
85-85: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
106-112: Improve clarity and grammar in the discussion of prior art.Consider the following improvements for clarity and grammar:
- This kind of requirement is handled for TypeScript libraries by [api-extractor](https://api-extractor.com/pages/tsdoc/doc_comment_syntax/#release-tags) - they have both "alpha" and "beta" markers with a somewhat opinionated flow attached - I'm not sure that level of granularity is necessary. + This kind of requirement is handled for TypeScript libraries by [api-extractor](https://api-extractor.com/pages/tsdoc/doc_comment_syntax/#release-tags), which has both "alpha" and "beta" markers with a somewhat opinionated flow attached. I'm not sure that level of granularity is necessary.Tools
LanguageTool
[grammar] ~106-~106: It appears that a preposition is missing after ‘Prior’.
Context: ...string experimental: true ``` ### Prior Art This kind of requirement is handled fo...(MISSING_PREPOSITION)
[formatting] ~110-~110: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...ta” API should NOT be used in production, because it may be changed or removed in a futur...(COMMA_BEFORE_BECAUSE)
113-129: Improve clarity and grammar in the discussion of unanswered questions, backwards compatibility, and alternatives.Consider the following improvements for clarity and grammar:
- Would this usage be considered invalid? + Would this usage be considered invalid? - The `experimental` field would default to false, meaning existing behaviour is preserved, and the new field is only used on an opt-in basis. + The `experimental` field would default to false, meaning existing behavior is preserved, and the new field is only used on an opt-in basis.Tools
LanguageTool
[uncategorized] ~127-~127: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... "experimental" as a first-class concept so there'd be reliance on conventions bein...(COMMA_COMPOUND_SENTENCE_2)
CONTRIBUTING.md (7)
3-3: Use consistent emphasis style.Replace underscores with asterisks for emphasis.
- ***Work in progress!** Each section links to issues that are relevant to fill out the rest of this document.* + ***Work in progress!*** Each section links to issues that are relevant to fill out the rest of this document.
11-11: Use a comma before 'and'.Add a comma before 'and' to separate independent clauses.
- If in doubt about a policy, please [ask on our Slack](https://communityinviter.com/apps/open-api/openapi) before opening a PR. + If in doubt about a policy, please [ask on our Slack](https://communityinviter.com/apps/open-api/openapi), before opening a PR.
15-15: Use consistent emphasis style.Replace underscores with asterisks for emphasis.
- No changes, ***no matter how trivial***, are ever made to the contents of published specifications. The only potential changes to those documents are updates to link URLs _if and only if_ the targeted document is moved by a 3rd party. Other changes to link URLs are not allowed. + No changes, ***no matter how trivial***, are ever made to the contents of published specifications. The only potential changes to those documents are updates to link URLs *if and only if* the targeted document is moved by a 3rd party. Other changes to link URLs are not allowed.Tools
Markdownlint
15-15: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
15-15: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
32-32: Use consistent emphasis style.Replace underscores with asterisks for emphasis.
- Schemas are only changed _after_ the specification is changed. Changes are made on the `main` branch, and should be made to the YAML version _only_. The JSON version will be generated automatically. + Schemas are only changed *after* the specification is changed. Changes are made on the `main` branch, and should be made to the YAML version *only*. The JSON version will be generated automatically.Tools
Markdownlint
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
56-56: Consider using an alternative to 'Bigger'.The word 'Bigger' tends to be overused. Consider using 'Larger' or 'More significant'.
- Bigger changes require a more formal process. + Larger changes require a more formal process.Tools
LanguageTool
[style] ~56-~56: The word ‘Bigger’ tends to be overused. Consider an alternative.
Context: ... changes are welcome as pull requests. Bigger changes require a more formal process. 1. Star...(BIG_DIFFERENCE)
109-109: Consider a shorter alternative.Consider a shorter alternative to avoid wordiness.
- In an effort to keep the list of issues up to date and easier to navigate through, issues get closed automatically when they become inactive. + To keep the list of issues up to date and easier to navigate through, issues get closed automatically when they become inactive.Tools
LanguageTool
[style] ~109-~109: Consider a shorter alternative to avoid wordiness.
Context: ...## Automated closure of issues Process In an effort to keep the list of issues up to date and ...(IN_ORDER_TO_PREMIUM)
114-114: Hyphenate 'follow-up'.When 'follow-up' is used as a noun or modifier, it needs to be hyphenated.
- the issue has been replied to by the triage team and is awaiting a follow up from the issue's author. + the issue has been replied to by the triage team and is awaiting a follow-up from the issue's author.Tools
LanguageTool
[uncategorized] ~114-~114: Loose punctuation mark.
Context: ...owing labels: *Needs author feedback: the issue has been replied to by the tr...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~114-~114: When ‘follow-up’ is used as a noun or modifier, it needs to be hyphenated.
Context: ...to by the triage team and is awaiting a follow up from the issue's author. This label nee...(VERB_NOUN_CONFUSION)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
Files selected for processing (19)
- .gitattributes (1 hunks)
- .github/ISSUE_TEMPLATE/config.yml (1 hunks)
- .github/templates/agenda.md (1 hunks)
- .github/workflows/respec.yaml (1 hunks)
- CONTRIBUTING.md (1 hunks)
- DEVELOPMENT.md (3 hunks)
- MAINTAINERS.md (1 hunks)
- SECURITY_CONSIDERATIONS.md (1 hunks)
- SPECIAL_INTEREST_GROUPS.md (1 hunks)
- package.json (2 hunks)
- proposals/2020-10-28-Experimental.md (1 hunks)
- schemas/v3.0/schema.yaml (1 hunks)
- schemas/v3.1/schema.yaml (1 hunks)
- scripts/md2html/build.sh (2 hunks)
- scripts/md2html/gist.css (1 hunks)
- scripts/md2html/md2html.js (12 hunks)
- tests/v3.0/examples.test.js (1 hunks)
- tests/v3.1/examples.test.js (1 hunks)
- tests/v3.1/schema.test.mjs (1 hunks)
Files skipped from review due to trivial changes (6)
- .gitattributes
- .github/workflows/respec.yaml
- DEVELOPMENT.md
- MAINTAINERS.md
- SPECIAL_INTEREST_GROUPS.md
- scripts/md2html/gist.css
Additional context used
LanguageTool
SECURITY_CONSIDERATIONS.md
[uncategorized] ~13-~13: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e generation, documentation generation, server side routing, and API testing. OpenAPI docum...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~21-~21: Possible missing comma found.
Context: ... an OpenAPI document, or across OpenAPI documents may cause a cycle. Tooling must detect ...(AI_HYDRA_LEO_MISSING_COMMA)
proposals/2020-10-28-Experimental.md
[uncategorized] ~26-~26: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ... Consider an API with two categories of thing in it: - Core, stable things, where we...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[style] ~31-~31: Consider shortening or rephrasing this to strengthen your wording.
Context: ...semver to the API as a whole. How do we make changes to the experimental stuff - without bumpin...(MAKE_CHANGES)
[typographical] ~31-~31: If the word ‘do’ starts a question (or is part of a question), add a question mark (“?”) at the end of the sentence.
Context: ... the core stuff we never want to break. ## Proposed solution Add an "experime...(PCT_DO_QUESTION_MARK)
[grammar] ~35-~35: It looks like ‘items’ doesn’t match ‘an’. Did you mean “an item” or just “items”?
Context: ...xperimental" field which specifies that an items in the API is not yet fully stable and ...(A_NNS_IN)
[grammar] ~35-~35: Did you mean “are”?
Context: ...hich specifies that an items in the API is not yet fully stable and supported, may...(SUBJECTVERBAGREEMENT_2)
[uncategorized] ~41-~41: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... this in the documentation they generate so consumers are made aware. Experimental ...(COMMA_COMPOUND_SENTENCE_2)
[style] ~63-~63: This phrase is redundant. Consider using “outside”.
Context: ...erimental status, meaning it may change outside of the normal breaking change process. Con...(OUTSIDE_OF)
[uncategorized] ~63-~63: A determiner appears to be missing. Consider inserting it.
Context: ...ess. Consumers SHOULD use with caution. Default value isfalse. ### Parameter Object...(AI_EN_LECTOR_MISSING_DETERMINER)
[style] ~74-~74: This phrase is redundant. Consider using “outside”.
Context: ...erimental status, meaning it may change outside of the normal breaking change process. Con...(OUTSIDE_OF)
[uncategorized] ~74-~74: A determiner appears to be missing. Consider inserting it.
Context: ...ess. Consumers SHOULD use with caution. Default value isfalse. Cannot betruewhen...(AI_EN_LECTOR_MISSING_DETERMINER)
[style] ~74-~74: To form a complete sentence, be sure to include a subject.
Context: ...with caution. Default value isfalse. Cannot betruewhen the parameter is `requir...(MISSING_IT_THERE)
[style] ~85-~85: This phrase is redundant. Consider using “outside”.
Context: ...erimental status, meaning it may change outside of the normal breaking change process. Con...(OUTSIDE_OF)
[uncategorized] ~85-~85: A determiner appears to be missing. Consider inserting it.
Context: ...ess. Consumers SHOULD use with caution. Default value isfalse. ### Example Spec ``...(AI_EN_LECTOR_MISSING_DETERMINER)
[grammar] ~106-~106: It appears that a preposition is missing after ‘Prior’.
Context: ...string experimental: true ``` ### Prior Art This kind of requirement is handled fo...(MISSING_PREPOSITION)
[formatting] ~110-~110: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...ta” API should NOT be used in production, because it may be changed or removed in a futur...(COMMA_BEFORE_BECAUSE)
[uncategorized] ~127-~127: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... "experimental" as a first-class concept so there'd be reliance on conventions bein...(COMMA_COMPOUND_SENTENCE_2)
CONTRIBUTING.md
[uncategorized] ~36-~36: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...576: [What is our authoritative spec URL and how do people find it?](https://github....(COMMA_COMPOUND_SENTENCE_2)
[style] ~56-~56: The word ‘Bigger’ tends to be overused. Consider an alternative.
Context: ... changes are welcome as pull requests. Bigger changes require a more formal process. 1. Star...(BIG_DIFFERENCE)
[grammar] ~71-~71: A verb may be missing. Did you mean “you have” or “you do”?
Context: ...to a new file, and complete it. Once you the document is ready, open a pull requ...(IF_YOU_ANY)
[style] ~109-~109: Consider a shorter alternative to avoid wordiness.
Context: ...## Automated closure of issues Process In an effort to keep the list of issues up to date and ...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~114-~114: Loose punctuation mark.
Context: ...owing labels: *Needs author feedback: the issue has been replied to by the tr...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~114-~114: When ‘follow-up’ is used as a noun or modifier, it needs to be hyphenated.
Context: ...to by the triage team and is awaiting a follow up from the issue's author. This label nee...(VERB_NOUN_CONFUSION)
[uncategorized] ~115-~115: Loose punctuation mark.
Context: ... by the workflow. *No recent activity: the issue hasn't received a reply from ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~116-~116: Loose punctuation mark.
Context: ...lly by the workflow. *Needs attention: The issue's author has replied since th...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~116-~116: Possible missing comma found.
Context: ...e theNeeds author feedbacklabel was set and the triage team will reply as soon ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~120-~120: Possible missing comma found.
Context: ...end the meeting, or to add items to the agenda as long as they plan on attending to pr...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~126-~126: The word “sign-off” is a noun. The verb is spelled with a space.
Context: ...OAI#3581: [Who and how many people need to sign-off on a PR, exactly?](https://github.com/O...(NOUN_VERB_CONFUSION)
Markdownlint
proposals/2020-10-28-Experimental.md
58-58: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time(MD001, heading-increment)
69-69: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time(MD001, heading-increment)
80-80: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time(MD001, heading-increment)
37-37: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
60-60: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
60-60: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
61-61: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
61-61: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
62-62: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
62-62: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
63-63: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
63-63: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
71-71: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
71-71: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
72-72: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
72-72: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
73-73: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
73-73: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
74-74: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
74-74: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
82-82: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
82-82: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
83-83: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
83-83: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
84-84: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
84-84: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
85-85: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
Table pipe style(MD055, table-pipe-style)
85-85: Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
CONTRIBUTING.md
5-5: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
5-5: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
15-15: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
15-15: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
91-91: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
91-91: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
Additional comments not posted (36)
package.json (5)
16-16: Ensure the build script is executable and correctly referenced.The build script
./scripts/md2html/build.shshould be executable and correctly referenced.Verification successful
The build script
./scripts/md2html/build.shis executable and correctly referenced.
- The script exists and has the necessary execute permissions.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the build script is executable and correctly referenced. # Test: Check if the build script exists and is executable. if [[ -x "./scripts/md2html/build.sh" ]]; then echo "Build script is executable." else echo "Build script is not executable or does not exist." fiLength of output: 102
28-28: Ensure therespecdependency is necessary and correctly integrated.Verify that the
respeclibrary is required and correctly integrated into the project.Verification successful
The
respecdependency is necessary and correctly integrated.The
respeclibrary is used extensively in thescripts/md2html/md2html.jsfile, confirming its necessity and correct integration into the project.
scripts/md2html/md2html.js: Multiple references torespec.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the `respec` dependency is necessary and correctly integrated. # Test: Search for the usage of `respec` in the project files. rg --type javascript $'respec'Length of output: 64
Script:
#!/bin/bash # Description: Verify the `respec` dependency is necessary and correctly integrated. # Test: Search for the usage of `respec` in the project files. rg --type js 'respec'Length of output: 1322
35-35: Review the changelog foryamlversion^2.5.0.Ensure that there are no breaking changes that could affect the project.
34-34: Review the changelog forvitestversion^2.0.5.Ensure that there are no breaking changes that could affect the project.
32-32: Review the changelog for@hyperjump/json-schemaversion^1.9.6.Ensure that there are no breaking changes that could affect the project.
tests/v3.0/examples.test.js (1)
14-14: Ensure the schema file path is correct.Verify that the schema file path
./schemas/v3.0/schema.jsonis correct and accessible.Verification successful
The schema file path is correct and accessible.
The file
./schemas/v3.0/schema.jsonis present and readable.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the schema file path is correct and accessible. # Test: Check if the schema file exists and is readable. if [[ -r "./schemas/v3.0/schema.json" ]]; then echo "Schema file is accessible." else echo "Schema file is not accessible." fiLength of output: 100
tests/v3.1/examples.test.js (1)
14-14: Ensure the schema file path is correct.Verify that the schema file path
./schemas/v3.1/schema.jsonis correct and accessible.Verification successful
The schema file path is correct and accessible.
- The schema file
./schemas/v3.1/schema.jsonis verified to be accessible.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the schema file path is correct and accessible. # Test: Check if the schema file exists and is readable. if [[ -r "./schemas/v3.1/schema.json" ]]; then echo "Schema file is accessible." else echo "Schema file is not accessible." fiLength of output: 100
tests/v3.1/schema.test.mjs (4)
Line range hint
1-5:
LGTM! Import statements are correct.The import statements are necessary and correctly included for the functionality provided in the file.
7-10: LGTM! FunctionparseYamlFromFileis correct.The function correctly reads and parses YAML files.
12-12: LGTM! Setting meta schema output format is correct.The block correctly sets the meta schema output format to BASIC.
14-14: LGTM! Validating OpenAPI schema is correct.The block correctly validates the OpenAPI schema.
.github/ISSUE_TEMPLATE/config.yml (2)
1-1: LGTM! Disabling blank issues is correct.The change aligns with the goal of requiring more structured issue submissions.
3-28: LGTM! Adding and modifying contact links is correct.The changes provide more specific guidance and resources for users.
SECURITY_CONSIDERATIONS.md (5)
3-10: LGTM! SectionOpenAPI Document Formatsis correct.The section provides valuable information on security considerations for different formats.
11-14: LGTM! SectionTooling and Usage Scenariosis correct.The section provides valuable information on the risks associated with different tooling.
Tools
LanguageTool
[uncategorized] ~13-~13: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e generation, documentation generation, server side routing, and API testing. OpenAPI docum...(EN_COMPOUND_ADJECTIVE_INTERNAL)
15-18: LGTM! SectionSecurity Schemesis correct.The section provides valuable information on selecting appropriate security schemes.
19-22: LGTM! SectionHandling External Resourcesis correct.The section provides valuable information on handling external resources.
Tools
LanguageTool
[uncategorized] ~21-~21: Possible missing comma found.
Context: ... an OpenAPI document, or across OpenAPI documents may cause a cycle. Tooling must detect ...(AI_HYDRA_LEO_MISSING_COMMA)
23-24: LGTM! SectionMarkdown and HTML Sanitizationis correct.The section provides valuable information on sanitizing Markdown and HTML content.
scripts/md2html/build.sh (4)
13-19: Ensure maintainers' information is up-to-date.The maintainers' information is hardcoded. Verify that the information is current and correct.
20-29: Ensure maintainers' information is up-to-date.The maintainers' information is hardcoded. Verify that the information is current and correct.
30-35: Verify commit hashes and necessity of copied files.Ensure that the commit hashes used in
git showare correct and that copying the maintainers' files for different versions is necessary.
Line range hint
40-57:
Verify the glob pattern and commands.Ensure that the glob pattern for processing markdown files and the commands for generating HTML files are correct.
Tools
Shellcheck
[warning] 11-11: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.
(SC2164)
.github/templates/agenda.md (2)
32-32: Verify the change in responsibility for "Approved spec PRs".Ensure that the change in responsibility from "TDC" to "@OAI/tsc" is correct and approved by the relevant stakeholders.
33-33: Verify the addition of the "Active Projects" section.Ensure that the addition of the "Active Projects" section and the assignment of responsibility to "@OAI/openapi-maintainers" is correct and relevant.
proposals/2020-10-28-Experimental.md (3)
1-14: Ensure metadata completeness and correctness.Verify that all metadata fields are complete and correctly formatted. Specifically, the "Review Manager" field is marked as TBD and should be updated.
15-19: Ensure change log completeness and correctness.Verify that the change log is correctly formatted and includes relevant information.
87-105: Ensure the example specification is clear and correctly formatted.Verify that the example specification using the experimental field is clear and correctly formatted.
CONTRIBUTING.md (1)
131-132: LGTM!The section is clear and well-written.
schemas/v3.0/schema.yaml (1)
983-983: LGTM! The addition offormat: uri-referenceimproves validation.This change ensures that the
operationRefproperty adheres to the URI reference format, enhancing schema validation and clarity.scripts/md2html/md2html.js (6)
26-26: Approved: Improved argument validation.The change from
.require(1)to.demandCommand(1)enhances clarity and ensures that at least one command is explicitly demanded.
52-88: Approved: Enriched document metadata.The additions of
latestVersion,logos, andotherLinksto therespecobject enhance the document's metadata and provide valuable resources for users.
89-137: Approved: Comprehensive references added.The expanded
localBibliosection with entries related to JSON Schema and OpenAPI resources provides comprehensive references within the generated documentation.
Line range hint
158-168: Approved: Improved visual representation.The new CSS rules for published dates and bibliographic references enhance the visual representation and readability of the document.
Line range hint
290-369: Approved: Enhanced markdown processing.The refinements in handling markdown lines, particularly in processing headings and constructing links, ensure correct formatting and accessibility.
305-365: Approved: Correct handling of markdown syntax errors and RFC references.The new logic to handle specific markdown syntax errors and harmonize RFC references ensures that links are correctly formatted and point to the appropriate resources.
schemas/v3.1/schema.yaml (1)
625-625: Approved: Enhanced specification with format attribute.The addition of the
formatattribute with the valueuri-referenceto theoperationRefproperty enhances the specification by clearly defining the expected format.
tests/v3.0/examples.test.js
Outdated
| const parseYamlFromFile = (filePath) => { | ||
| const schemaYaml = readFileSync(filePath, "utf8"); | ||
| return YAML.parse(schemaYaml, { prettyErrors: true }); | ||
| }; |
There was a problem hiding this comment.
Ensure error handling for file read operations.
Add error handling to manage potential file read errors.
const parseYamlFromFile = (filePath) => {
try {
const schemaYaml = readFileSync(filePath, "utf8");
return YAML.parse(schemaYaml, { prettyErrors: true });
} catch (error) {
console.error(`Error reading or parsing file ${filePath}:`, error);
throw error;
}
};Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const parseYamlFromFile = (filePath) => { | |
| const schemaYaml = readFileSync(filePath, "utf8"); | |
| return YAML.parse(schemaYaml, { prettyErrors: true }); | |
| }; | |
| const parseYamlFromFile = (filePath) => { | |
| try { | |
| const schemaYaml = readFileSync(filePath, "utf8"); | |
| return YAML.parse(schemaYaml, { prettyErrors: true }); | |
| } catch (error) { | |
| console.error(`Error reading or parsing file ${filePath}:`, error); | |
| throw error; | |
| } | |
| }; |
tests/v3.0/examples.test.js
Outdated
| describe("v3.0 - Validate examples", async () => { | ||
| readdirSync(folder, { withFileTypes: true }) | ||
| .filter((entry) => entry.isFile() && /\.yaml$/.test(entry.name)) | ||
| .forEach((entry) => { | ||
| test(entry.name, () => { | ||
| const instance = parseYamlFromFile(folder + entry.name); | ||
| const output = validateOpenApi(instance, BASIC); | ||
| expect(output.valid).to.equal(true); | ||
| }); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
Ensure proper handling of asynchronous code.
The describe block contains asynchronous code. Ensure proper handling of asynchronous operations.
describe("v3.0 - Validate examples", async () => {
const files = readdirSync(folder, { withFileTypes: true })
.filter((entry) => entry.isFile() && /\.yaml$/.test(entry.name));
for (const entry of files) {
test(entry.name, async () => {
const instance = parseYamlFromFile(folder + entry.name);
const output = await validateOpenApi(instance, BASIC);
expect(output.valid).to.equal(true);
});
}
});Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| describe("v3.0 - Validate examples", async () => { | |
| readdirSync(folder, { withFileTypes: true }) | |
| .filter((entry) => entry.isFile() && /\.yaml$/.test(entry.name)) | |
| .forEach((entry) => { | |
| test(entry.name, () => { | |
| const instance = parseYamlFromFile(folder + entry.name); | |
| const output = validateOpenApi(instance, BASIC); | |
| expect(output.valid).to.equal(true); | |
| }); | |
| }); | |
| }); | |
| describe("v3.0 - Validate examples", () => { | |
| const files = readdirSync(folder, { withFileTypes: true }) | |
| .filter((entry) => entry.isFile() && /\.yaml$/.test(entry.name)); | |
| for (const entry of files) { | |
| test(entry.name, async () => { | |
| const instance = parseYamlFromFile(folder + entry.name); | |
| const output = await validateOpenApi(instance, BASIC); | |
| expect(output.valid).to.equal(true); | |
| }); | |
| } | |
| }); |
tests/v3.1/examples.test.js
Outdated
| const parseYamlFromFile = (filePath) => { | ||
| const schemaYaml = readFileSync(filePath, "utf8"); | ||
| return YAML.parse(schemaYaml, { prettyErrors: true }); | ||
| }; |
There was a problem hiding this comment.
Ensure error handling for file read operations.
Add error handling to manage potential file read errors.
const parseYamlFromFile = (filePath) => {
try {
const schemaYaml = readFileSync(filePath, "utf8");
return YAML.parse(schemaYaml, { prettyErrors: true });
} catch (error) {
console.error(`Error reading or parsing file ${filePath}:`, error);
throw error;
}
};Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const parseYamlFromFile = (filePath) => { | |
| const schemaYaml = readFileSync(filePath, "utf8"); | |
| return YAML.parse(schemaYaml, { prettyErrors: true }); | |
| }; | |
| const parseYamlFromFile = (filePath) => { | |
| try { | |
| const schemaYaml = readFileSync(filePath, "utf8"); | |
| return YAML.parse(schemaYaml, { prettyErrors: true }); | |
| } catch (error) { | |
| console.error(`Error reading or parsing file ${filePath}:`, error); | |
| throw error; | |
| } | |
| }; |
tests/v3.1/examples.test.js
Outdated
| describe("v3.1 - Validate examples", async () => { | ||
| readdirSync(folder, { withFileTypes: true }) | ||
| .filter((entry) => entry.isFile() && /\.yaml$/.test(entry.name)) | ||
| .forEach((entry) => { | ||
| test(entry.name, () => { | ||
| const instance = parseYamlFromFile(folder + entry.name); | ||
| const output = validateOpenApi(instance, BASIC); | ||
| expect(output.valid).to.equal(true); | ||
| }); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
Ensure proper handling of asynchronous code.
The describe block contains asynchronous code. Ensure proper handling of asynchronous operations.
describe("v3.1 - Validate examples", async () => {
const files = readdirSync(folder, { withFileTypes: true })
.filter((entry) => entry.isFile() && /\.yaml$/.test(entry.name));
for (const entry of files) {
test(entry.name, async () => {
const instance = parseYamlFromFile(folder + entry.name);
const output = await validateOpenApi(instance, BASIC);
expect(output.valid).to.equal(true);
});
}
});Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| describe("v3.1 - Validate examples", async () => { | |
| readdirSync(folder, { withFileTypes: true }) | |
| .filter((entry) => entry.isFile() && /\.yaml$/.test(entry.name)) | |
| .forEach((entry) => { | |
| test(entry.name, () => { | |
| const instance = parseYamlFromFile(folder + entry.name); | |
| const output = validateOpenApi(instance, BASIC); | |
| expect(output.valid).to.equal(true); | |
| }); | |
| }); | |
| }); | |
| describe("v3.1 - Validate examples", async () => { | |
| const files = readdirSync(folder, { withFileTypes: true }) | |
| .filter((entry) => entry.isFile() && /\.yaml$/.test(entry.name)); | |
| for (const entry of files) { | |
| test(entry.name, async () => { | |
| const instance = parseYamlFromFile(folder + entry.name); | |
| const output = await validateOpenApi(instance, BASIC); | |
| expect(output.valid).to.equal(true); | |
| }); | |
| } | |
| }); |
There was a problem hiding this comment.
Actionable comments posted: 4
Outside diff range, codebase verification and nitpick comments (2)
proposals/2024-08-01-Self-Identification.md (2)
54-54: Consider simplifying the phrase "take into account".The phrase "take into account" might be wordy. Consider using "consider" for conciseness.
- Many tools that perform reference rewriting do not take into account the added complexities of referencing in OAS 3.1 compared to 3.0 and earlier. + Many tools that perform reference rewriting do not consider the added complexities of referencing in OAS 3.1 compared to 3.0 and earlier.Tools
LanguageTool
[style] ~54-~54: ‘take into account’ might be wordy. Consider a shorter alternative.
Context: ...that perform reference rewriting do not take into account the added complexities of referencing i...(EN_WORDINESS_PREMIUM_TAKE_INTO_ACCOUNT)
98-98: Consider simplifying the phrase "exactly the same".The phrase "exactly the same" might be wordy. Consider using "identical" for conciseness.
- OAS 3.2 and Arazzo 1.1 documents that do not use the `self` field will behave exactly the same as OAS 3.1 and Arazzo 1.0 documents. + OAS 3.2 and Arazzo 1.1 documents that do not use the `self` field will behave identically to OAS 3.1 and Arazzo 1.0 documents.Tools
LanguageTool
[style] ~98-~98: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...do not use theselffield will behave exactly the same as OAS 3.1 and Arazzo 1.0 documents. T...(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- proposals/2024-08-01-Self-Identification.md (1 hunks)
Additional context used
LanguageTool
proposals/2024-08-01-Self-Identification.md
[style] ~54-~54: ‘take into account’ might be wordy. Consider a shorter alternative.
Context: ...that perform reference rewriting do not take into account the added complexities of referencing i...(EN_WORDINESS_PREMIUM_TAKE_INTO_ACCOUNT)
[grammar] ~56-~56: It appears that a preposition is missing after ‘Prior’.
Context: ...S 3.1 compared to 3.0 and earlier. ### Prior Art Self-identification of resources with ...(MISSING_PREPOSITION)
[style] ~98-~98: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...do not use theselffield will behave exactly the same as OAS 3.1 and Arazzo 1.0 documents. T...(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)
[style] ~106-~106: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...re scanning all Objects for the keyword prior to declaring that a reference target with ...(EN_WORDINESS_PREMIUM_PRIOR_TO)
Markdownlint
proposals/2024-08-01-Self-Identification.md
42-42: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
43-43: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
44-44: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
45-45: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
47-47: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
48-48: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
49-49: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
73-73: Expected: underscore; Actual: asterisk
Emphasis style(MD049, emphasis-style)
73-73: Expected: underscore; Actual: asterisk
Emphasis style(MD049, emphasis-style)
20-20: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
Additional comments not posted (3)
proposals/2024-08-01-Self-Identification.md (3)
22-24: Introduction section is clear and informative.The explanation of the proposal's context and necessity is well-articulated.
82-84: Detailed Design section is comprehensive.The section provides detailed and clear guidance on implementing the
selffield.
56-56: Add a preposition after "Prior".The phrase "Prior Art" is missing a preposition. Consider adding "in" for grammatical correctness.
- ### Prior Art + ### In Prior ArtLikely invalid or redundant comment.
Tools
LanguageTool
[grammar] ~56-~56: It appears that a preposition is missing after ‘Prior’.
Context: ...S 3.1 compared to 3.0 and earlier. ### Prior Art Self-identification of resources with ...(MISSING_PREPOSITION)
| |Date |Responsible Party |Description | | ||
| |---- | ---------------- | ---------- | | ||
| |2024-08-01 | @handrews | Initial submission |
There was a problem hiding this comment.
Fix the table pipe style.
The table pipe style is inconsistent. Ensure both leading and trailing pipes are used for clarity.
- |Date |Responsible Party |Description |
- |---- | ---------------- | ---------- |
- |2024-08-01 | @handrews | Initial submission
+ |Date |Responsible Party |Description |
+ |---- | ---------------- | ---------- |
+ |2024-08-01 | @handrews | Initial submission |Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| |Date |Responsible Party |Description | | |
| |---- | ---------------- | ---------- | | |
| |2024-08-01 | @handrews | Initial submission | |
| |Date |Responsible Party |Description | | |
| |---- | ---------------- | ---------- | | |
| |2024-08-01 | @handrews | Initial submission | |
Tools
Markdownlint
20-20: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
| |Tag |Value | | ||
| |---- | ---------------- | | ||
| |Proposal |[2024-08-01 Self-Identification](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/{2024-08-01-Self-Identification-and-Bundling.md})| |
There was a problem hiding this comment.
Fix the broken link in the Proposal field.
The link in the Proposal field appears to be broken due to incorrect path formatting. Ensure the path is correct and accessible.
- |Proposal |[2024-08-01 Self-Identification](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/{2024-08-01-Self-Identification-and-Bundling.md})|
+ |Proposal |[2024-08-01 Self-Identification](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/2024-08-01-Self-Identification-and-Bundling.md)|Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| |Tag |Value | | |
| |---- | ---------------- | | |
| |Proposal |[2024-08-01 Self-Identification](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/{2024-08-01-Self-Identification-and-Bundling.md})| | |
| |Tag |Value | | |
| |---- | ---------------- | | |
| |Proposal |[2024-08-01 Self-Identification](https://github.com/OAI/OpenAPI-Specification/tree/main/proposals/2024-08-01-Self-Identification-and-Bundling.md)| |
| 1. Check the `openapi` or `arazzo` field in the root OpenAPI or Arazzo Object to determine the specification version | ||
| 1. Check the `jsonSchemaDialect` field for the default Schema Object dialect | ||
| 1. Determine the base URI per RFC3986 §5.1.2-5.1.4 (in most cases, use the retrieval URL per §5.1.3) | ||
| 1. ***NEW*** Check the `self` field for a base URI per RFC3986 §5.1.1; if it exists, resolve it against the base URI from the previous step and use the result as the document's actual base URI |
There was a problem hiding this comment.
Use underscores for emphasis.
The emphasis style should use underscores instead of asterisks for consistency.
- 1. ***NEW*** Check the `self` field for a base URI per RFC3986 §5.1.1; if it exists, resolve it against the base URI from the previous step and use the result as the document's actual base URI
+ 1. __NEW__ Check the `self` field for a base URI per RFC3986 §5.1.1; if it exists, resolve it against the base URI from the previous step and use the result as the document's actual base URICommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. ***NEW*** Check the `self` field for a base URI per RFC3986 §5.1.1; if it exists, resolve it against the base URI from the previous step and use the result as the document's actual base URI | |
| 1. __NEW__ Check the `self` field for a base URI per RFC3986 §5.1.1; if it exists, resolve it against the base URI from the previous step and use the result as the document's actual base URI |
Tools
Markdownlint
73-73: Expected: underscore; Actual: asterisk
Emphasis style(MD049, emphasis-style)
73-73: Expected: underscore; Actual: asterisk
Emphasis style(MD049, emphasis-style)
| * Working around network challenges: | ||
| * Restrictive network security policies | ||
| * Intermittent connectivity | ||
| * High latency / low bandwidth | ||
| * Document hosts that [require authentication](https://github.com/OAI/OpenAPI-Specification/issues/3270) | ||
| * Abstracting development vs testing vs deployment details | ||
| * Allowing `.json` and `.yaml` file extensions during development, as is preferred by most IDEs | ||
| * Using extensions in development and HTTP content negotiation in production | ||
| * Differing source control repository structure (particularly of shared documents) vs deployment directory and server layouts |
There was a problem hiding this comment.
Fix unordered list indentation.
The unordered lists are not properly indented. Adjust the indentation to improve readability.
- * Working around network challenges:
- * Restrictive network security policies
- * Intermittent connectivity
- * High latency / low bandwidth
- * Document hosts that [require authentication](https://github.com/OAI/OpenAPI-Specification/issues/3270)
- * Abstracting development vs testing vs deployment details
- * Allowing `.json` and `.yaml` file extensions during development, as is preferred by most IDEs
- * Using extensions in development and HTTP content negotiation in production
- * Differing source control repository structure (particularly of shared documents) vs deployment directory and server layouts
+ * Working around network challenges:
+ * Restrictive network security policies
+ * Intermittent connectivity
+ * High latency / low bandwidth
+ * Document hosts that [require authentication](https://github.com/OAI/OpenAPI-Specification/issues/3270)
+ * Abstracting development vs testing vs deployment details
+ * Allowing `.json` and `.yaml` file extensions during development, as is preferred by most IDEs
+ * Using extensions in development and HTTP content negotiation in production
+ * Differing source control repository structure (particularly of shared documents) vs deployment directory and server layoutsCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * Working around network challenges: | |
| * Restrictive network security policies | |
| * Intermittent connectivity | |
| * High latency / low bandwidth | |
| * Document hosts that [require authentication](https://github.com/OAI/OpenAPI-Specification/issues/3270) | |
| * Abstracting development vs testing vs deployment details | |
| * Allowing `.json` and `.yaml` file extensions during development, as is preferred by most IDEs | |
| * Using extensions in development and HTTP content negotiation in production | |
| * Differing source control repository structure (particularly of shared documents) vs deployment directory and server layouts | |
| * Working around network challenges: | |
| * Restrictive network security policies | |
| * Intermittent connectivity | |
| * High latency / low bandwidth | |
| * Document hosts that [require authentication](https://github.com/OAI/OpenAPI-Specification/issues/3270) | |
| * Abstracting development vs testing vs deployment details | |
| * Allowing `.json` and `.yaml` file extensions during development, as is preferred by most IDEs | |
| * Using extensions in development and HTTP content negotiation in production | |
| * Differing source control repository structure (particularly of shared documents) vs deployment directory and server layouts |
Tools
Markdownlint
42-42: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
43-43: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
44-44: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
45-45: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
47-47: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
48-48: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
49-49: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
There was a problem hiding this comment.
Actionable comments posted: 4
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
Files selected for processing (7)
- scripts/md2html/md2html.js (10 hunks)
- tests/md2html/fixtures/.gitattributes (1 hunks)
- tests/md2html/fixtures/basic-new.html (1 hunks)
- tests/md2html/fixtures/basic-new.md (1 hunks)
- tests/md2html/fixtures/basic-old.html (1 hunks)
- tests/md2html/fixtures/basic-old.md (1 hunks)
- tests/md2html/md2html.test.js (1 hunks)
Files skipped from review due to trivial changes (1)
- tests/md2html/fixtures/.gitattributes
Additional context used
Markdownlint
tests/md2html/fixtures/basic-old.md
5-5: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
tests/md2html/fixtures/basic-new.md
27-27: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Additional comments not posted (8)
tests/md2html/fixtures/basic-old.html (1)
1-23: HTML Fixture Approved.The HTML content appears to be correctly structured for a test fixture, with appropriate use of inline styles and scripts.
tests/md2html/fixtures/basic-new.html (1)
1-31: Enhanced HTML Fixture Approved.The HTML content is well-structured and includes additional elements like code blocks for more comprehensive testing.
scripts/md2html/md2html.js (6)
26-26: Command Requirement Update Approved.The change from
.require(1)to.demandCommand(1)improves clarity in enforcing command-line argument requirements.
37-45: Accessibility Improvement Approved.The addition of
tabindex="0"to<pre>tags enhances accessibility by allowing keyboard navigation to code blocks.
52-88: Preface Function Enhancements Approved.The additions to the
respecobject improve the metadata and usability of the generated HTML document.
110-123: Styling Adjustments Approved.The CSS updates enhance the readability and visual consistency of the document.
204-286: Markdown Processing Improvements Approved.The refinements in handling code blocks and headings enhance the accuracy and structure of the HTML output.
241-248: RFC Link Formatting Approved.The adjustments ensure that RFC links are accurate and consistent, maintaining document integrity.
tests/md2html/fixtures/basic-old.md
Outdated
|
|
||
| Text for first chapter | ||
|
|
||
| ### Version 30.0.1 |
There was a problem hiding this comment.
Fix heading level increment.
The heading level should increment by one level at a time. Change ### to ## for consistency.
-### Version 30.0.1
+## Version 30.0.1Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Version 30.0.1 | |
| ## Version 30.0.1 |
Tools
Markdownlint
5-5: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
| text/plain | ||
| ``` | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Specify a language for the code block.
Fenced code blocks should have a language specified for better readability and syntax highlighting.
-```
+```textTools
Markdownlint
27-27: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
tests/md2html/md2html.test.js
Outdated
| describe("v3.0 - Validate examples", async () => { | ||
| readdirSync(folder, { withFileTypes: true }) | ||
| .filter((entry) => entry.isFile() && /\.md$/.test(entry.name)) | ||
| .forEach((entry) => { | ||
| test(entry.name, async () => { | ||
| const expected = readFileSync( | ||
| folder + entry.name.replace(".md", ".html"), | ||
| "utf8", | ||
| ); | ||
| const output = await md2html([entry.name], folder); | ||
| expect(output.stdout).to.equal(expected); | ||
| }); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
Enhance test case naming and error handling.
Consider using more descriptive test names to clarify what each test is validating. Additionally, ensure that errors are properly handled and reported in the test output.
-describe("v3.0 - Validate examples", async () => {
+describe("Markdown to HTML conversion tests", async () => {Committable suggestion was skipped due to low confidence.
tests/md2html/md2html.test.js
Outdated
| function md2html(args, cwd) { | ||
| return new Promise((res) => { | ||
| exec( | ||
| `node ${resolve("./scripts/md2html/md2html.js")} ${args.join(" ")}`, | ||
| { cwd }, | ||
| (error, stdout, stderr) => { | ||
| res({ | ||
| code: error?.code || 0, | ||
| error, | ||
| stdout, | ||
| stderr, | ||
| }); | ||
| }, | ||
| ); | ||
| }); |
There was a problem hiding this comment.
Handle errors more explicitly in md2html.
Currently, errors are being captured but not explicitly handled or reported. Consider logging or throwing errors to make debugging easier.
- return new Promise((res) => {
+ return new Promise((res, rej) => {
exec(
`node ${resolve("./scripts/md2html/md2html.js")} ${args.join(" ")}`,
{ cwd },
(error, stdout, stderr) => {
- res({
+ if (error) {
+ rej(error);
+ } else {
+ res({
code: error?.code || 0,
error,
stdout,
stderr,
});
+ }
},
);
});Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| function md2html(args, cwd) { | |
| return new Promise((res) => { | |
| exec( | |
| `node ${resolve("./scripts/md2html/md2html.js")} ${args.join(" ")}`, | |
| { cwd }, | |
| (error, stdout, stderr) => { | |
| res({ | |
| code: error?.code || 0, | |
| error, | |
| stdout, | |
| stderr, | |
| }); | |
| }, | |
| ); | |
| }); | |
| function md2html(args, cwd) { | |
| return new Promise((res, rej) => { | |
| exec( | |
| `node ${resolve("./scripts/md2html/md2html.js")} ${args.join(" ")}`, | |
| { cwd }, | |
| (error, stdout, stderr) => { | |
| if (error) { | |
| rej(error); | |
| } else { | |
| res({ | |
| code: error?.code || 0, | |
| error, | |
| stdout, | |
| stderr, | |
| }); | |
| } | |
| }, | |
| ); | |
| }); |
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- scripts/md2html/gist.css (3 hunks)
- tests/md2html/fixtures/basic-new.html (1 hunks)
- tests/md2html/fixtures/basic-old.html (1 hunks)
Files skipped from review due to trivial changes (1)
- scripts/md2html/gist.css
Files skipped from review as they are similar to previous changes (2)
- tests/md2html/fixtures/basic-new.html
- tests/md2html/fixtures/basic-old.html
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
Files selected for processing (13)
- .gitignore (1 hunks)
- CONTRIBUTORS.md (1 hunks)
- package.json (2 hunks)
- scripts/md2html/build.sh (2 hunks)
- scripts/md2html/md2html.js (6 hunks)
- tests/md2html/README.md (1 hunks)
- tests/md2html/fixtures/basic-new.html (1 hunks)
- tests/md2html/fixtures/basic-new.maintainers (1 hunks)
- tests/md2html/fixtures/basic-new.md (1 hunks)
- tests/md2html/fixtures/basic-old.html (1 hunks)
- tests/md2html/fixtures/basic-old.maintainers (1 hunks)
- tests/md2html/fixtures/basic-old.md (1 hunks)
- tests/md2html/md2html.test.js (1 hunks)
Files skipped from review due to trivial changes (5)
- .gitignore
- CONTRIBUTORS.md
- tests/md2html/README.md
- tests/md2html/fixtures/basic-new.maintainers
- tests/md2html/fixtures/basic-old.maintainers
Files skipped from review as they are similar to previous changes (3)
- tests/md2html/fixtures/basic-new.html
- tests/md2html/fixtures/basic-old.html
- tests/md2html/md2html.test.js
Additional context used
Markdownlint
tests/md2html/fixtures/basic-old.md
5-5: Expected: h2; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
tests/md2html/fixtures/basic-new.md
49-49: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Additional comments not posted (5)
tests/md2html/fixtures/basic-old.md (1)
5-5: Fix heading level increment.The heading level should increment by one level at a time. Change
####to##for consistency.-#### Version 30.0.1 +## Version 30.0.1Tools
Markdownlint
5-5: Expected: h2; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
tests/md2html/fixtures/basic-new.md (1)
49-51: Specify a language for the code block.Fenced code blocks should have a language specified for better readability and syntax highlighting.
-``` +```textTools
Markdownlint
49-49: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
package.json (1)
16-17: LGTM!The updates to the scripts and dependencies enhance the build and testing processes. The changes are well-structured and should improve functionality and maintainability.
Also applies to: 26-36
scripts/md2html/build.sh (1)
Line range hint
13-57: LGTM!The changes enhance the maintainability and clarity of the script. The use of temporary files for processing is a good practice to avoid clutter.
Tools
Shellcheck
[warning] 11-11: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.
(SC2164)
scripts/md2html/md2html.js (1)
22-22: LGTM!The updates to command-line handling, highlighting, and markdown processing enhance functionality and maintainability. The changes align with best practices for accessibility and markdown processing.
Also applies to: 33-39, 46-84, 95-119, 191-214, 234-284
There was a problem hiding this comment.
Actionable comments posted: 5
Outside diff range, codebase verification and nitpick comments (2)
CONTRIBUTING.md (2)
85-85: Consider alternative word choice.The word "Bigger" can be replaced with a more formal alternative.
Consider using "Larger" or "More significant" instead of "Bigger".
Tools
LanguageTool
[style] ~85-~85: The word ‘Bigger’ tends to be overused. Consider an alternative.
Context: ... changes are welcome as pull requests. Bigger changes require a more formal process. 1. Star...(BIG_DIFFERENCE)
138-138: Consider a shorter alternative to avoid wordiness.The phrase "In an effort to" can be shortened for conciseness.
Consider using "To" instead of "In an effort to".
Tools
LanguageTool
[style] ~138-~138: Consider a shorter alternative to avoid wordiness.
Context: ...## Automated closure of issues Process In an effort to keep the list of issues up to date and ...(IN_ORDER_TO_PREMIUM)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
Files selected for processing (3)
- .markdownlint.yaml (1 hunks)
- CONTRIBUTING.md (1 hunks)
- package.json (2 hunks)
Files skipped from review due to trivial changes (1)
- .markdownlint.yaml
Files skipped from review as they are similar to previous changes (1)
- package.json
Additional context used
LanguageTool
CONTRIBUTING.md
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...ose documents are updates to link URLs if and only if the targeted document is m...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~36-~36: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...576: [What is our authoritative spec URL and how do people find it?](https://github....(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~47-~47: Possible missing comma found.
Context: ...wing additional rules should be followed but currently are not enforced by tooling: ...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~85-~85: The word ‘Bigger’ tends to be overused. Consider an alternative.
Context: ... changes are welcome as pull requests. Bigger changes require a more formal process. 1. Star...(BIG_DIFFERENCE)
[grammar] ~100-~100: A verb may be missing. Did you mean “you have” or “you do”?
Context: ...to a new file, and complete it. Once you the document is ready, open a pull requ...(IF_YOU_ANY)
[style] ~138-~138: Consider a shorter alternative to avoid wordiness.
Context: ...## Automated closure of issues Process In an effort to keep the list of issues up to date and ...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~143-~143: Loose punctuation mark.
Context: ...owing labels: *Needs author feedback: the issue has been replied to by the tr...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~143-~143: When ‘follow-up’ is used as a noun or modifier, it needs to be hyphenated.
Context: ...to by the triage team and is awaiting a follow up from the issue's author. This label nee...(VERB_NOUN_CONFUSION)
[uncategorized] ~144-~144: Loose punctuation mark.
Context: ... by the workflow. *No recent activity: the issue hasn't received a reply from ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~145-~145: Loose punctuation mark.
Context: ...lly by the workflow. *Needs attention: The issue's author has replied since th...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~145-~145: Possible missing comma found.
Context: ...e theNeeds author feedbacklabel was set and the triage team will reply as soon ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~149-~149: Possible missing comma found.
Context: ...end the meeting, or to add items to the agenda as long as they plan on attending to pr...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~155-~155: The word “sign-off” is a noun. The verb is spelled with a space.
Context: ...OAI#3581: [Who and how many people need to sign-off on a PR, exactly?](https://github.com/O...(NOUN_VERB_CONFUSION)
Markdownlint
CONTRIBUTING.md
5-5: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
5-5: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
15-15: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
15-15: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
120-120: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
120-120: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
Additional comments not posted (2)
CONTRIBUTING.md (2)
100-100: Complete the sentence.A verb may be missing. Did you mean “you have” or “you do”?
- Once you the document is ready, open a pull request on the main branch. + Once you have the document ready, open a pull request on the main branch.Tools
LanguageTool
[grammar] ~100-~100: A verb may be missing. Did you mean “you have” or “you do”?
Context: ...to a new file, and complete it. Once you the document is ready, open a pull requ...(IF_YOU_ANY)
155-155: Correct the verb form.The word “sign-off” is a noun. The verb is spelled with a space.
- [Who and how many people need to sign-off on a PR, exactly?] + [Who and how many people need to sign off on a PR, exactly?]Tools
LanguageTool
[grammar] ~155-~155: The word “sign-off” is a noun. The verb is spelled with a space.
Context: ...OAI#3581: [Who and how many people need to sign-off on a PR, exactly?](https://github.com/O...(NOUN_VERB_CONFUSION)
CONTRIBUTING.md
Outdated
| Markdown files in this project should follow the style enforced by the [markdownlint tool](https://www.npmjs.com/package/markdownlint), | ||
| as configured by the `.markdownlint.json` file in the root of the project. | ||
|
|
||
| The following additional rules should be followed but currently are not enforced by tooling: |
There was a problem hiding this comment.
Add missing comma for clarity.
A comma is needed for clarity in the sentence.
Apply this diff to add the missing comma:
- The following additional rules should be followed but currently are not enforced by tooling:
+ The following additional rules should be followed, but currently are not enforced by tooling:Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The following additional rules should be followed but currently are not enforced by tooling: | |
| The following additional rules should be followed, but currently are not enforced by tooling: |
Tools
LanguageTool
[uncategorized] ~47-~47: Possible missing comma found.
Context: ...wing additional rules should be followed but currently are not enforced by tooling: ...(AI_HYDRA_LEO_MISSING_COMMA)
CONTRIBUTING.md
Outdated
|
|
||
| ### Changing the schemas | ||
|
|
||
| Schemas are only changed _after_ the specification is changed. Changes are made on the `main` branch, and should be made to the YAML version _only_. The JSON version will be generated automatically. |
There was a problem hiding this comment.
Fix emphasis style.
The emphasis style should be consistent. Use asterisks instead of underscores.
Apply this diff to fix the emphasis style:
- Changes are made on the `main` branch, and should be made to the YAML version _only_.
+ Changes are made on the `main` branch, and should be made to the YAML version *only*.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Schemas are only changed _after_ the specification is changed. Changes are made on the `main` branch, and should be made to the YAML version _only_. The JSON version will be generated automatically. | |
| Schemas are only changed _after_ the specification is changed. Changes are made on the `main` branch, and should be made to the YAML version *only*. The JSON version will be generated automatically. |
Tools
Markdownlint
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
32-32: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
CONTRIBUTING.md
Outdated
|
|
||
| ### No changes to published specifications | ||
|
|
||
| No changes, ***no matter how trivial***, are ever made to the contents of published specifications. The only potential changes to those documents are updates to link URLs _if and only if_ the targeted document is moved by a 3rd party. Other changes to link URLs are not allowed. |
There was a problem hiding this comment.
Fix emphasis style and add missing comma.
The emphasis style should be consistent, and a comma is needed for clarity.
Apply this diff to fix the emphasis style and add the missing comma:
- The only potential changes to those documents are updates to link URLs _if and only if_ the targeted document is moved by a 3rd party.
+ The only potential changes to those documents are updates to link URLs *if and only if* the targeted document is moved by a 3rd party.Committable suggestion was skipped due to low confidence.
Tools
LanguageTool
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...ose documents are updates to link URLs if and only if the targeted document is m...(AI_HYDRA_LEO_MISSING_COMMA)
Markdownlint
15-15: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
15-15: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
|
|
||
| This process makes use of the following labels: | ||
|
|
||
| * `Needs author feedback`: the issue has been replied to by the triage team and is awaiting a follow up from the issue's author. This label needs to be added manually by people doing triage/experts whenever they reply. It's removed automatically by the workflow. |
There was a problem hiding this comment.
Hyphenate "follow-up" when used as a noun.
The term "follow-up" should be hyphenated when used as a noun.
Apply this diff to correct the hyphenation:
- ...is awaiting a follow up from the issue's author.
+ ...is awaiting a follow-up from the issue's author.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * `Needs author feedback`: the issue has been replied to by the triage team and is awaiting a follow up from the issue's author. This label needs to be added manually by people doing triage/experts whenever they reply. It's removed automatically by the workflow. | |
| * `Needs author feedback`: the issue has been replied to by the triage team and is awaiting a follow-up from the issue's author. This label needs to be added manually by people doing triage/experts whenever they reply. It's removed automatically by the workflow. |
Tools
LanguageTool
[uncategorized] ~143-~143: Loose punctuation mark.
Context: ...owing labels: *Needs author feedback: the issue has been replied to by the tr...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~143-~143: When ‘follow-up’ is used as a noun or modifier, it needs to be hyphenated.
Context: ...to by the triage team and is awaiting a follow up from the issue's author. This label nee...(VERB_NOUN_CONFUSION)
CONTRIBUTING.md
Outdated
|
|
||
| ***Work in progress!** Each section links to issues that are relevant to fill out the rest of this document.* | ||
|
|
||
| We are currently working on [defining and documenting our new processes](https://github.com/orgs/OAI/projects/5). Information in this document is up-to-date. Older _(and sometimes now inaccurate)_ documentation can be found in [DEVELOPMENT.md](DEVELOPMENT.md), which will be removed when everything is updated and documented here. |
There was a problem hiding this comment.
Fix emphasis style.
The emphasis style should be consistent. Use asterisks instead of underscores.
Apply this diff to fix the emphasis style:
- Older _(and sometimes now inaccurate)_ documentation can be found...
+ Older *(and sometimes now inaccurate)* documentation can be found...Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| We are currently working on [defining and documenting our new processes](https://github.com/orgs/OAI/projects/5). Information in this document is up-to-date. Older _(and sometimes now inaccurate)_ documentation can be found in [DEVELOPMENT.md](DEVELOPMENT.md), which will be removed when everything is updated and documented here. | |
| We are currently working on [defining and documenting our new processes](https://github.com/orgs/OAI/projects/5). Information in this document is up-to-date. Older *(and sometimes now inaccurate)* documentation can be found in [DEVELOPMENT.md](DEVELOPMENT.md), which will be removed when everything is updated and documented here. |
Tools
Markdownlint
5-5: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
5-5: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (4)
EDITORS.md (4)
3-3: Add a blank line after the heading.To improve readability and adhere to markdown best practices, add a blank line after the "## Active" heading.
Apply this diff:
## Active +Tools
Markdownlint
3-3: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
14-14: Add a blank line after the heading.To improve readability and adhere to markdown best practices, add a blank line after the "## Emeritus" heading.
Apply this diff:
## Emeritus +Tools
Markdownlint
14-14: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
4-4: Add a blank line before the list.To improve readability and adhere to markdown best practices, add a blank line before the list under the "## Active" heading.
Apply this diff:
## ActiveTools
Markdownlint
4-4: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
15-15: Add a blank line before the list.To improve readability and adhere to markdown best practices, add a blank line before the list under the "## Emeritus" heading.
Apply this diff:
## EmeritusTools
Markdownlint
15-15: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- EDITORS.md (1 hunks)
- MAINTAINERS.md (2 hunks)
- scripts/md2html/build.sh (2 hunks)
Files skipped from review due to trivial changes (1)
- MAINTAINERS.md
Files skipped from review as they are similar to previous changes (1)
- scripts/md2html/build.sh
Additional context used
Markdownlint
EDITORS.md
3-3: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
14-14: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
4-4: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
15-15: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (6)
- package.json (2 hunks)
- scripts/md2html/md2html.js (6 hunks)
- tests/md2html/fixtures/basic-new.html (1 hunks)
- tests/md2html/fixtures/basic-old.html (1 hunks)
- tests/md2html/fixtures/basic-old.md (1 hunks)
- vitest.config.js (1 hunks)
Files skipped from review as they are similar to previous changes (3)
- package.json
- tests/md2html/fixtures/basic-new.html
- tests/md2html/fixtures/basic-old.html
Additional context used
Markdownlint
tests/md2html/fixtures/basic-old.md
5-5: Expected: h2; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
Additional comments not posted (9)
vitest.config.js (1)
1-7: Configuration looks good!The Vitest configuration is correctly set up with
forceRerunTriggersto rerun tests when files in the specified directories change.tests/md2html/fixtures/basic-old.md (1)
5-5: Fix heading level increment.The heading level should increment by one level at a time. Change
####to##for consistency.Tools
Markdownlint
5-5: Expected: h2; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
scripts/md2html/md2html.js (7)
22-22: Update command-line argument handling.The change from
.require(1)to.demandCommand(1)clarifies the intent of enforcing the presence of a command.
34-35: Enhance accessibility in syntax highlighting.Adding
tabindex="0"to<pre>tags improves accessibility by allowing keyboard navigation.
46-84: Expandrespecobject with new properties.The addition of
latestVersion,logos, andotherLinksenhances the metadata and accessibility of the specification document.
207-209: Replace deprecated HTML tags.The replacement of
<a name="..."/>with<span id="..."></span>is a modern and semantically appropriate update.
229-232: Harmonize RFC URLs.The changes ensure that all RFC URLs use HTTPS and point to the correct resources.
Line range hint
289-307: Fix heading indentation logic.The logic ensures that each heading is at most one level deeper than the previous heading, improving document structure.
319-357: Wrap section text in<section>tags.This change improves the document structure for tools like ReSpec, ensuring proper sectioning.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
Files selected for processing (1)
- package.json (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- package.json
main: examples are on learn.openapis.org
Schema Publish workflow
…ments main: schema-publish workflow - fix reviewers
main: respec workflow - same reviewers as for schema publishing
use markdownlint-cli2 and refresh package-lock.json
Remove mdv from workflow
Improve Markdown linting and use it on more files
Bumps [@hyperjump/json-schema](https://github.com/hyperjump-io/json-schema) from 1.12.1 to 1.13.0. - [Commits](hyperjump-io/json-schema@v1.12.1...v1.13.0) --- updated-dependencies: - dependency-name: "@hyperjump/json-schema" dependency-version: 1.13.0 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>
Bumps [vitest](https://github.com/vitest-dev/vitest/tree/HEAD/packages/vitest) from 3.1.1 to 3.1.2. - [Release notes](https://github.com/vitest-dev/vitest/releases) - [Commits](https://github.com/vitest-dev/vitest/commits/v3.1.2/packages/vitest) --- updated-dependencies: - dependency-name: vitest dependency-version: 3.1.2 dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>
…son-schema-1.13.0
Improve text/event-stream support with comment support and generally better configuration (one rule wasn't doing anything). Add support for JSONL/NDJSON (basically JSON without the check for values separated only by whitespace) and JSON Text Sequences (which requires using `0x1E` as the record separator, and highlighting it separately).
Bumps [respec](https://github.com/speced/respec) from 35.3.0 to 35.3.1. - [Release notes](https://github.com/speced/respec/releases) - [Changelog](https://github.com/speced/respec/blob/main/CHANGELOG.md) - [Commits](speced/respec@v35.3.0...v35.3.1) --- updated-dependencies: - dependency-name: respec dependency-version: 35.3.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>
Bumps [@hyperjump/json-schema](https://github.com/hyperjump-io/json-schema) from 1.13.0 to 1.14.0. - [Commits](hyperjump-io/json-schema@v1.13.0...v1.14.0) --- updated-dependencies: - dependency-name: "@hyperjump/json-schema" dependency-version: 1.14.0 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>
Bumps [vitest](https://github.com/vitest-dev/vitest/tree/HEAD/packages/vitest) from 3.1.2 to 3.1.3. - [Release notes](https://github.com/vitest-dev/vitest/releases) - [Commits](https://github.com/vitest-dev/vitest/commits/v3.1.3/packages/vitest) --- updated-dependencies: - dependency-name: vitest dependency-version: 3.1.3 dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>
…son-schema-1.14.0
highlight.js: support for JSONL, JSON-Seq, basic multipart, improve text/event-stream
Bumps [respec](https://github.com/speced/respec) from 35.3.1 to 35.4.0. - [Release notes](https://github.com/speced/respec/releases) - [Changelog](https://github.com/speced/respec/blob/main/CHANGELOG.md) - [Commits](speced/respec@v35.3.1...v35.4.0) --- updated-dependencies: - dependency-name: respec dependency-version: 35.4.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>
Bumps [@hyperjump/json-schema](https://github.com/hyperjump-io/json-schema) from 1.14.0 to 1.14.1. - [Commits](hyperjump-io/json-schema@v1.14.0...v1.14.1) --- updated-dependencies: - dependency-name: "@hyperjump/json-schema" dependency-version: 1.14.1 dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>
…son-schema-1.14.1
Bumps [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) from 0.17.2 to 0.18.1. - [Changelog](https://github.com/DavidAnson/markdownlint-cli2/blob/main/CHANGELOG.md) - [Commits](DavidAnson/markdownlint-cli2@v0.17.2...v0.18.1) --- updated-dependencies: - dependency-name: markdownlint-cli2 dependency-version: 0.18.1 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>
Bumps [yaml](https://github.com/eemeli/yaml) from 2.7.1 to 2.8.0. - [Release notes](https://github.com/eemeli/yaml/releases) - [Commits](eemeli/yaml@v2.7.1...v2.8.0) --- updated-dependencies: - dependency-name: yaml dependency-version: 2.8.0 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>
Bump yaml from 2.7.1 to 2.8.0
See Commits and Changes for more details.
Created by
pull[bot]
Can you help keep this open source service alive? 💖 Please sponsor : )
Summary by CodeRabbit
New Features
Documentation
Chores