API reference docs (with OpenAPI specs) for Core and Enterprise #5870
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
- Adds basic support for core and enterprise in getswagger.sh
- Adds custom OpenAPI info for Core and Enterprise
- Validates as OpenAPI 3.0 (using Spectral)
- operationId
- tags
- Revises use of Legacy, v2
- TODO: need to check and validate in UI, adjust tags if nec.
- Add and remove components
- Update parameters
- Add examples
- Add tests for Core
…contain a .config.yml OpenAPI config
… - prevents undefined GTM object errors in dev - Stub Google Tag Manager in the test
- Adds InfluxDB 3 Core API reference - Updates scripts - Removes non-valid info.summary field from specs, replaces with description in metadata - Simplifies frontmatter generation for HTML template - Reorg of file structure to mirror the content structure. - Moves OSS v2 into v2/v2/ref.yml to follow the same pattern as others - Replaces isDefault API config field with specific aliases. - Misc. fixes. - Remove generated HTML files.
- Add a custom x-influxdata-short-description field that replaces the previous non-standard summary field used by Redocly. - Double quote the title and description vars to preserve the entire value when passing them to the CLI
- Adds the widget script to template.hbs. - Copies branding color and font styles from js/ask-ai.js - Copies position and some sizes from the configuration docs. - This will be replaced when the API uplift is completed and using the same layouts as the rest of the site.
…groups. Closes Remove tag groups from API ref docs that duplicate endpoints in the "All endpoints" tag group. #5868
- Fix broken links reported by the e2e link checker. - Add an e2e test for checking internal and external links in API reference docs. Low effort, big win.
jstirnaman
requested review from
MeelahMe,
pauldix,
peterbarnett03 and
sanderson
sanderson
approved these changes
Mar 4, 2025
Co-authored-by: Scott Anderson <[email protected]>
jstirnaman
commented
Mar 4, 2025
hiltontj
reviewed
Mar 5, 2025
Co-authored-by: Trevor Hilton <[email protected]>
Co-authored-by: Trevor Hilton <[email protected]>
jstirnaman
commented
Mar 5, 2025
…steps: Apply suggestions from @hiltontj. List data flow steps ported from 0fdd0efa0. Use enum for field column types.
|
@sanderson Updated to add write data flow steps
|
|
@peterbarnett03 FYI, publishing Core and Enterprise API references |
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.
View on staging:
https://test2.docs.influxdata.com/influxdb3/core/reference/api/ | Diff: Core spec (ref.yml)
https://test2.docs.influxdata.com/influxdb3/enterprise/reference/api/ | Diff: Enterprise spec (ref.yml)
Adds HTTP API reference sections for Core and Monolith.
.info; haven't added anything about multi-node params (if they're relevant for the API)Adds Cypress test for link checking in API docs -- fixes a bunch of reported broken links ❤️
Restructures existing specs, configs, etc. to fall in line with
content/Updates and fixes in
getswagger.shandgenerate-api-docs.shscripts.Cleans up headings and mentions of OSS - removes them or specifies "OSS v2". Closes fix(api-refs): specify v2 in InfluxDB OSS headings #5866
Closes API docs: replace
/influxdb/latestwith/influxdb/v2#5865Closes Add Ask AI widget to API reference docs #5867
Closes Remove tag groups from API ref docs that duplicate endpoints in the "All endpoints" tag group. #5868
Misc. fixes reported by pytest.