Validate OpenAPI slug with pattern #1029
Merged
Conversation
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
🦋 Changeset detectedLatest commit: b796508 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Pull Request Overview
This PR adds validation for OpenAPI specification slugs to ensure they match required patterns and length constraints before publishing. The changes extract validation constants from the OpenAPI spec and implement client-side validation with improved error handling.
Key Changes:
- Added slug validation using pattern matching and length constraints from the API spec
- Introduced a logger utility for consistent error messaging
- Created a build-time script to extract constants from OpenAPI specification
Reviewed Changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/cli/src/openapi/publish.ts | Added validateSlug function to validate slugs before API calls; improved error handling with logger |
| packages/cli/src/logger.ts | New logger utility with colored console output for different log levels |
| packages/cli/package.json | Added picocolors dependency for terminal color support |
| packages/api/src/index.ts | Exported constants module to make validation constants available |
| packages/api/scripts/extract-constants.ts | Build script to extract validation constants from OpenAPI specification |
| packages/api/build.sh | Added step to run constants extraction during build |
| packages/api/.gitignore | Ignore generated constants.ts file |
| .changeset/funny-geese-mix.md | Changeset documenting the slug validation feature |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
nolannbiron
force-pushed
the
nolann/rnd-8496-dont-allow-openapi-spec-published-through-the-cli-to-have-a
branch
from
b977d2d to
5b88011
Compare
taranvohra
approved these changes
Oct 29, 2025
commit: |
nolannbiron
force-pushed
the
nolann/rnd-8496-dont-allow-openapi-spec-published-through-the-cli-to-have-a
branch
from
9aeb770 to
b796508
Compare
nolannbiron
deleted the
nolann/rnd-8496-dont-allow-openapi-spec-published-through-the-cli-to-have-a
branch
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.