Commit Graph

7639 Commits (jts/core-api-ref)

Author SHA1 Message Date
Jason Stirnaman aab07d8b5e feat(api): InfluxDB3 Core API reference, API fixes, and e2e tests
- 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.
2025-02-21 17:22:56 -06:00
Jason Stirnaman 82ac28ae6f fix(api): Update glossary links. Remove old cloud-serverless directory 2025-02-21 10:17:52 -06:00
Jason Stirnaman 998881fa56 fix(api): Remove fake from API template; stub Google Tag Manager in the test 2025-02-21 09:50:58 -06:00
Jason Stirnaman d7baeab092 fix(api): Only call Google Tag Manager if hostname has influxdata.com - prevents undefined GTM object errors in dev 2025-02-19 10:37:20 -06:00
Jason Stirnaman 1737f8dab6 Merge branch 'hotfix-api-back-link' into core-api-ref 2025-02-19 10:18:39 -06:00
Jason Stirnaman 2e0b929633 fix(ci): Remove Nightwatch dependency 2025-02-19 09:58:48 -06:00
Jason Stirnaman 131ce852a3 hotfix(api): update header back link for new product structure 2025-02-19 09:55:25 -06:00
Jason Stirnaman c507563efc fix(api): Skip to next api-docs directory if the current dir doesn't contain a .config.yml OpenAPI config 2025-02-18 15:24:32 -06:00
Jason Stirnaman 33e464c771 chore(api): API reference validation and content fixes. 2025-02-18 14:57:34 -06:00
Jason Stirnaman e333706adf chore(monolith): Core HTTP API and OpenAPI .info content for Core and Enterprise 2025-02-18 14:54:50 -06:00
Scott Anderson cca6347797 hotfix: backup restore toc fixes 2025-02-18 10:42:38 -07:00
Scott Anderson e96159b374 hotfix: more backup restore formatting fixes 2025-02-18 10:27:31 -07:00
Jason Stirnaman 62f9e2a28e WIP: core testing 2025-02-18 11:25:49 -06:00
Jason Stirnaman 44e78c49ef fix(v3): WIP: more Core and Enterprise API ref fixes
- Add and remove components
- Update parameters
- Add examples
2025-02-18 11:23:43 -06:00
Jason Stirnaman 40ce1d56e7 feat(v3): WIP: Revise API specs for Core and Enterprise
- 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.
2025-02-18 11:23:43 -06:00
Peter Barnett 29fcede1e3 Update API reference documentation 2025-02-18 11:23:42 -06:00
Scott Anderson cb4b035af8 hotfix: fix backup restore code formatting 2025-02-18 10:21:49 -07:00
Scott Anderson 91b1288c19
Clustered backup and restore (#5833)
* add clustered backup and restore content

* add clustered backup and restore content

* shorted definition lines

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-02-18 10:13:27 -07:00
Jason Stirnaman 6de0ea00b8
Merge pull request #5835 from influxdata/get-product-edition
chore: Add product-key shortcode
2025-02-15 11:36:16 -06:00
Jason Stirnaman 02ccab8799
Merge branch 'master' into get-product-edition 2025-02-14 17:11:18 -06:00
Jason Stirnaman ff4b8d4f22 chore: Add product-key shortcode - displays the short version name extracted from the current page URL. 2025-02-14 17:07:09 -06:00
Jason Stirnaman ba6f13fae3
Merge pull request #5834 from influxdata/pd/influxdb3-plugins-doc
hotfix(mono): code formatting
2025-02-14 13:59:02 -06:00
Jason Stirnaman 39d9f4651a
Merge branch 'master' into pd/influxdb3-plugins-doc 2025-02-14 13:54:58 -06:00
Jason Stirnaman 2c1f2aaae8 fix(mono): code formatting 2025-02-14 13:45:13 -06:00
Paul Dix ff1538dca7
Merge pull request #5791 from influxdata/pd/influxdb3-plugins-doc
Add plugin documentation for Core and Enterprise
2025-02-14 14:36:19 -05:00
Jason Stirnaman c7e83ed9b0
Merge pull request #5830 from influxdata/jts/influxdb3-plugins-doc
Jts/influxdb3 plugins doc
2025-02-14 13:10:58 -06:00
Jason Stirnaman c9dbdbddcd
Merge branch 'master' into pd/influxdb3-plugins-doc 2025-02-14 12:49:45 -06:00
David Rusnak eb8ddc4237
Merge pull request #5831 from influxdata/clustered-release-20250212
docs: add release notes for 20250212 clustered release
2025-02-14 13:20:41 -05:00
David Rusnak 6b588059f6 fix: address comments 2025-02-14 12:38:19 -05:00
Jason Stirnaman dc0c9fe18f chore(monolith): Update installing and configuring plugins:
Updates the guide and examples for using the latest influxdb3 install command.
Provides more Docker-specific examples.
Cleanup.
2025-02-14 09:50:55 -06:00
Jason Stirnaman 3abf1c506d chore: resolve conflicts 2025-02-14 09:39:44 -06:00
David Rusnak 494b923582 docs: add release notes for 20250212 2025-02-14 09:47:57 -05:00
Jason Stirnaman cd3ad9e0a1 chore: Update and resolve yarn.lock 2025-02-12 13:52:06 -06:00
Paul Dix 338fcfec8b Add plugin documentation for Core and Enterprise 2025-02-12 13:52:04 -06:00
Scott Anderson c0436bd0f3 Add 'last_cache' and 'distinct_cache' SQL functions (#5828)
* add last_value and distinct_value sql functions

* fixed cache function names
2025-02-12 13:48:30 -06:00
Jason Stirnaman 6fb23ee1d4 Update content/shared/v3-core-get-started/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-02-12 13:48:30 -06:00
Jason Stirnaman bb19446ea9 fix(v3): Core and Enterprise Get Started, problems and cleanup. 2025-02-12 13:48:30 -06:00
Scott Anderson 991bf462ca Add missing influxdb3 serve configuration options (#5822)
* add missing influxdb3 serve configuration options

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-02-12 13:48:30 -06:00
Scott Anderson 513c732540 hotfix: clarify that influxdb_v2 tokens for telegraf cannot be empty strings (#5824) 2025-02-12 13:48:30 -06:00
Jason Stirnaman 2232f6a0ef hotfix(ai): increase size (width) to fit the Additional Feedback form modal 2025-02-12 13:48:30 -06:00
Jason Stirnaman 04e2cade93 hotfix(ai): x modal position and question column span
hotfix(ai): x modal position and question column span
2025-02-12 13:48:30 -06:00
Jason Stirnaman 9947c72495 chore(e2e): Add Cypress for link checking and end-to-end tests. Fix broken links revealed by tests.
- Adds Cypress and a few basic tests for the global topnav, the home page, and link-checking.
- For link-checking, pass a comma-delimited list of URLs in an exported cypress_test_subjects environment variable. For examples, see the convenience commands in package.json
2025-02-12 13:48:30 -06:00
Jason Stirnaman e17fc86ea4 fix(ai): example button width 2025-02-12 13:48:30 -06:00
Jason Stirnaman 80e6bdb005 fix(3): Broken links to CLI reference 2025-02-12 13:48:29 -06:00
Jason Stirnaman 7004809570 Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-02-12 13:48:29 -06:00
Jason Stirnaman fcd6e02a1f fix(products): Match when extracting product name from the URL. Add more custom AI example questions. 2025-02-12 13:48:29 -06:00
Jason Stirnaman fe7a2e0739 fix(ai): Don't override default modalExampleQuestions unless they're defined in products.yml. 2025-02-12 13:48:29 -06:00
Jason Stirnaman c173edce68 Initial Kapa.ai chat integration.
Continue refactoring JavaScript into a component pattern and ESM.
Replaces some jQuery with native DOM API.

chore(ai): reference documentation and instructions for training AI

chore(ai): implement Kapa AI chat widget
- Move script tag to HTML template to make it obvious.
- Cleanup javascript to make it more component-like
- Set Kapa attributes, support setting userid

chore(js): add JS dependencies, previously referenced in script tags, to package.json for JS builds.

fix(api): indents

chore(js): package Mermaid diagram library

chore(js): refactor JS for AIChat and Theme as examples of using the component pattern for HTML/CSS/JS

chore(js): Use the new local-storage API in refactored module code and in code not yet ported. Cleanup syntax in local-storage and make functions available from window.LocalStorageAPI.

fix(js): theme.js name-change

chore(js): fix ai-chat.js file name

fix(js): refactor:
- componentNames are snakecase in HTML
- replace DOM selection method and jQuery eventhandler assignment
- remove old theme.js references

chore(ai): configure chat window overlay, size, and position:
- removes overlay and scroll lock
- positions chat to the right and bottom
- expands sample question width to 12 cols

chore(ai): edit disclaimer

fix(ai): size and position

chore(js): make ai-chat specific to configuration and and setting userid (for testing and future use).

fix(js): copy referrerHost variable to v3-wayfinding instead of relying on influxdb-url to assign it.

chore(ai): add a footer div at page bottom to contain modal triggers for custom-time and ask-ai. Still needs some CSS help. Moves tooltip text from CSS to HTML data attribute.

chore(ai): dynamically load AI script tag after DOMContentLoaded to avoid race conditions. Call initialization from the modal trigger module and pass the show trigger function to the onload handler.

fix(ai): fix modal triggers to viewport

fix(modal-triggers): stack the triggers into a single column.

restyle footer widgets

updated time selector modal to use correct storage term

minor style update

WIP(ai-chat): get product data

chore(js): Factor out pageContext module from influxdb-url.js

chore(js): Refactor helpers.js out of inflluxdb-url.js

WIP: refactor influxdburl - minimal changes for module conversions

feat(ai): Custom AI chat example questions product and version.
Ask AI example questions:
- Adds support for customizing example Ask AI questions per product or version.
- Configure questions in site `data/products.yml`; otherwise, it uses default questions from `ask-ai.js`

Context, page, and product data:
- Adds sample URLs for remaining versions in influxdb_urls
- `page-context.js` consolidates and exports constants for page context (protocol, host, path, referrer) and path-to-data mappings for product and influxdb_url site data

Module refactor:
- Refactors some JavaScript into ES6 modules, and refactors some of those further into a Component pattern--just vanilla JS and no shadow DOM stuff. The Component pattern that uses data attributes to "bind" JavaScript modules with CSS and HTML is a popular approach in modern web development. This pattern enhances modularity, reusability, and maintainability by associating behavior (JavaScript), structure (HTML), and style (CSS) through the use of data attributes.
- `assets/main.js` is the entrypoint
- Passes pageParams from the Hugo page to modules that import `@params`.
- Moves most external dependencies out of `script` tags and into package.json to be managed with `yarn`.
- Adds `eslint`.
- For modules that aren't yet components, wraps execution statements inside an `initialize()` function and calls the function from `main.js` on `DOMContentLoaded`.
- For components, if the page contains the `data-component="<component-name>"`, the matching element is passed to the component function on `DOMContentLoaded`.
- I tried to avoid changing logic where it wasn't necessary.

Update DOC_GPT_PROFILE.md

customize ai chat modal styles

fix(influxdb-url): Rename to cloud_dedicated in influxdb_urls.yml, remove newly added placeholder URL and use the extant default, refactor
- Rename  to  in influxdb_urls.yml
- Fix influxdb-url.js and data provision in local-storage.js to use the new name, mapping it to  to retain the existing local storage key

chore(api-lib): Use local-storage import instead of window global

chore(js): cleanup

fix(js): Ensure feature-callout initializes on page load

fix(theme): Load preferred theme before making the page visible. Execute a predefined function by specifying the function name in data-theme-callback

fix(search-toggle): Restores toggling the search field when sidebar is collapsed. Moves the event handler to a new search-button component

fix(ai): Fix custom attribute assignment. Rename property to ai_example_questions

Include the word `Bearer` or `Token`, a space, and your **token** value (all case-sensitive). Fix TOC links.
Fixes #5781

fix(api-docs): Update API reference directories and generation script for influxdb3 URL paths, update links and names in reference content

fix(api-ref): Update getswagger.sh destination paths to use the new directory structure when fetching spec files. Update the redocly  plugin module path.

hotfix: fix hlevel bug in children shortcode

Remove underline from custom time widget

add color to custom time widget styling
2025-02-12 13:48:29 -06:00
Jason Stirnaman a15f8c8154 chore: Update and resolve yarn.lock 2025-02-12 10:49:00 -06:00
Jason Stirnaman f7acce87c4
Merge pull request #5816 from influxdata/e2e-link-testing
chore(e2e): Add Cypress for link checking and end-to-end tests. Fix b…
2025-02-10 16:52:25 -06:00