Flag experimental - #1023
Merged
Merged
Conversation
FloThinksPi
force-pushed
the
flag-experimental
branch
9 times, most recently
from
August 8, 2025 14:53
aef1fe8 to
6fb0d2c
Compare
FloThinksPi
force-pushed
the
flag-experimental
branch
from
August 8, 2025 14:59
6fb0d2c to
2102f1e
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds an experimental flag to the repository and introduces a GitHub issue management script. The main purpose is to flag the project as experimental and provide tooling for automated OpenAPI specification quality checking.
- Adds experimental notice to README with disclaimer about production use
- Introduces automated issue management script for OpenAPI quality checks
- Updates file references to use consistent PascalCase naming convention
- Removes dredd dependency from package.json and updates GitHub Actions to use Alpine containers
Reviewed Changes
Copilot reviewed 52 out of 72 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Added experimental flag and disclaimer, updated command examples |
| scripts/manage_issues.js | New automated script for creating GitHub issues to track OpenAPI quality checks |
| scripts/enpoints.txt | List of API endpoints for the quality checking script |
| package.json | Removed dredd dependency |
| .github/workflows/*.yaml | Updated to use Alpine containers and improved lint configuration |
| apis/cf/latest/**/*.yaml | Standardized file references to use PascalCase naming |
| const RATE_LIMIT_DELAY = 10000; // 10 seconds between API calls | ||
| const MAX_RETRIES = 10; | ||
|
|
||
| const endpoints = fs.readFileSync(path.join(__dirname, 'enpoints.txt'), 'utf-8'); |
There was a problem hiding this comment.
The filename 'enpoints.txt' is misspelled. It should be 'endpoints.txt'.
Suggested change
| const endpoints = fs.readFileSync(path.join(__dirname, 'enpoints.txt'), 'utf-8'); | |
| const endpoints = fs.readFileSync(path.join(__dirname, 'endpoints.txt'), 'utf-8'); |
| - [ ] **Clarity and Accuracy**: Check for clarity, accuracy, and completeness in the summary and description. | ||
| - [ ] **Concise Summary**: Ensure the \`summary\` provides a short, easy-to-understand overview of the operation. | ||
| - [ ] **Detailed Description**: Verify the \`description\` provides enough detail, including any specific behaviors or constraints. | ||
| - [ ] **GithubMarkdown Syntax**: Ensure that GithubMarkdown syntax is used correctly for rich text representation.` |
There was a problem hiding this comment.
The term 'GithubMarkdown' should be 'GitHub Markdown' (with proper capitalization and spacing).
Suggested change
| - [ ] **GithubMarkdown Syntax**: Ensure that GithubMarkdown syntax is used correctly for rich text representation.` | |
| - [ ] **GitHub Markdown Syntax**: Ensure that GitHub Markdown syntax is used correctly for rich text representation.` |
jochenehret
self-requested a review
August 8, 2025 15:03
jochenehret
approved these changes
Aug 8, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.