Repository navigation
Add interface samples from examples-diags-apis to the examples - #137
Merged
Merged
Conversation
The OpenAPI, AsyncAPI, gRPC and GraphQL specifications from the examples-diags-apis repository now live in examples/docs/includes/apis/ and are included by a new `interfaces` document, with its use case diagram rewritten as valid PlantUML (the original was cut off mid-line). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Summary
examples-diags-apisrepository intoexamples/docs/includes/apis/.interfacesdocument (examples/docs/interfaces.md) that includes each specification from its own file and draws the use case diagram. The original.pumlfile was cut off mid-line and used Mermaid-style syntax, so it is rewritten as valid PlantUML. Two links were added to finish it: Bank Employee to Customer Support, and Pay Bills to the third-party payment service.examples/py-doc.ymland the examples README, and adds a test that checks all four specifications appear in the HTML output.Testing
pytest: 1021 passed, 13 skippedpy-doc lint docs --engine builtin --strictinexamples/: 0 issuespy-doc build interfaceswith the Docker tool image: Word and HTML built, PlantUML diagram drawn🤖 Generated with Claude Code