docs: adjustment to API docs and alternative patterns added#6
Open
ihorman wants to merge 4 commits intocyberfabric:mainfrom
Open
docs: adjustment to API docs and alternative patterns added#6ihorman wants to merge 4 commits intocyberfabric:mainfrom
ihorman wants to merge 4 commits intocyberfabric:mainfrom
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
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.
Restructure API documentation and add alternative patterns
Description
Restructured documentation to separate REST from alternative API patterns and enhanced existing sections with comprehensive details:
Restructuring:
GraphQL/,gRPC/, andAsyncAPI/directories with dedicated API.md filesREST Enhancements (additive only, no deletions):
Alternative API Patterns (new):
Bug Fixes:
Type of Change
Checklist
git commit -s)Related Issues
Comprehensive API documentation coverage:
Files Changed
README.md- Updated structure with REST/GraphQL/gRPC/AsyncAPI sectionsREST/API.md- Enhanced with retry strategies, auth details, webhooks, removed non-REST sectionsREST/PAGINATION.md- Added alternative envelope format noteREST/STATUS_CODES.md- Fixed header formatGraphQL/API.md- New file with GraphQL guidelinesgRPC/API.md- New file with gRPC guidelinesAsyncAPI/API.md- New file with AsyncAPI guidelines