Add Python examples and code tabs to API docs#31
Merged
Conversation
- Add example files in examples/api/ (.sh and .py) for each endpoint - Add include-code shortcode to load code from files with highlighting - Add Curl/Python tabs to all API doc pages using Compose theme tabs - Add plugins API endpoint documentation (GET /api/plugins) - Add Python client install instructions (v1.1.0+) - Add shellcheck and Python syntax checks to Makefile and CI - Standardize all curl examples with api-key header
Use variables for API key, query, domain, IP, and plugin name. Match the same queries and parameters between curl and Python. URL-encode query parameters with jq for search and bulk.
2 tasks
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
built-in tab shortcodes
examples/api/(
.shand.py)include-codeshortcode to load and syntax-highlight code fromexternal files
GET /api/plugins,GET /api/plugins/:name)make lint-shell(shellcheck) andmake check-examples-python(py_compile) targets
api-keyheader__pycache__/to.gitignoreTest plan