fix: add error schemas, CONTRIBUTING, SECURITY, and auto-changelog #755
Open
topsonDev wants to merge 1 commit into
Open
fix: add error schemas, CONTRIBUTING, SECURITY, and auto-changelog #755topsonDev wants to merge 1 commit into
topsonDev wants to merge 1 commit into
Conversation
…lug#730 solutions-plug#731 solutions-plug#728 — openapi.yaml: add missing error response schemas - Added optional `details` field to the `ApiError` schema - Added 400, 401, 403, 404, 429, and 500 responses to all endpoints that were previously missing them (health, statistics, markets, blockchain, newsletter, email, and webhook endpoints) - frontend/src/lib/api/client.ts: ApiError now exposes `code` (string) and `details` (object) fields parsed from typed API error responses solutions-plug#729 — automate CHANGELOG generation with git-cliff - Added cliff.toml with conventional-commit parser and grouped sections - Rewrote .github/workflows/release.yml to trigger on version tags, run git-cliff (orhun/git-cliff-action), commit CHANGELOG.md, and create a GitHub Release with the generated notes - Added .github/workflows/protect-changelog.yml CI check that fails any PR touching CHANGELOG.md manually - CONTRIBUTING.md documents commit conventions and the no-manual-edit rule solutions-plug#730 — add CONTRIBUTING.md - Created CONTRIBUTING.md covering: development setup, branch naming, commit conventions (Conventional Commits), PR checklist, running tests for all services, and code style requirements - Added link to CONTRIBUTING.md in docs/README.md under Want to Contribute solutions-plug#731 — add SECURITY.md - Created SECURITY.md covering: supported versions, how to report (GitHub private advisory + email), response timeline, coordinated disclosure policy, in/out-of-scope definitions, and security best practices for contributors
|
@topsonDev Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
topsonDev
changed the title
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
1 participant
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.
Summary
This PR resolves four issues in a single change set.
#728 — Add missing error response schemas to openapi.yaml
detailsfield to theApiErrorschema (services/api/openapi.yaml)400,401,403,404,429, and500responses to every endpoint that was previously missing them (health, statistics, markets, blockchain, newsletter, email, and webhook endpoints)frontend/src/lib/api/client.ts:ApiErrornow exposes acode(string) anddetails(object) field, parsed from the typed API error body#729 — Automate CHANGELOG generation with git-cliff
cliff.tomlwith a conventional-commit parser and grouped changelog sections.github/workflows/release.ymlto trigger on version tags (v*.*.*), run git-cliff viaorhun/git-cliff-action, commit the updatedCHANGELOG.md, and create a GitHub Release with the generated notes.github/workflows/protect-changelog.yml: CI check that fails any PR that touchesCHANGELOG.mdmanuallyCONTRIBUTING.mddocuments the commit convention and the no-manual-edit rule#730 — Add CONTRIBUTING.md
CONTRIBUTING.mdat the repo root covering: development setup, branch naming, commit conventions (Conventional Commits), PR checklist, running tests for all services, and code style requirementsCONTRIBUTING.mdindocs/README.mdunder the Want to Contribute section#731 — Add SECURITY.md
SECURITY.mdat the repo root covering: supported versions, how to report (GitHub private advisory + email), response timeline, coordinated disclosure policy, in/out-of-scope definitions, and security best practices for contributorsFiles Changed
services/api/openapi.yamldetailstoApiErrorschema; added missing 4xx/5xx responses to all endpointsfrontend/src/lib/api/client.tsApiErrornow carriescodeanddetailsfrom typed error responsescliff.toml.github/workflows/release.yml.github/workflows/protect-changelog.ymlCONTRIBUTING.mdSECURITY.mddocs/README.mdCloses #728
Closes #729
Closes #730
Closes #731