Commit Graph

198 Commits (master)

Author SHA1 Message Date
Jason Stirnaman 687b8343b7 chore(mono): /api/v3 processing engine request parameters:
- Update trigger-spec syntax for schedule triggers
- Specify that cron only supports extended cron format
- Provide examples and pattern validation for trigger-specs
- Update response status
- Cleanup  use
- Misc. updates and cleanup
- Add test plugins
2025-06-06 17:16:20 -05:00
Jason Stirnaman 36e65a663e
Merge branch 'master' into 6071-chore-v2-partial-writes 2025-05-22 16:38:56 -05:00
Jason Stirnaman 8d0d4acf55 fix(oss2): Troubleshoot partial writes for v2 and Cloud
- OSS v2 supports partial writes and returns a 422 that describes rejected points, depending on the problem.
- Update API spec
- Move file to content/shared for Cloud
2025-05-22 16:30:41 -05:00
Jason Stirnaman 18b90035a4 fix: broken links and formatting, missing Management API ReDoc security section for auth types 2025-05-19 14:09:38 -05:00
Jason Stirnaman 1dce052e56 fix(JS): Rename CommonJS scripts to .cjs extension, keep type: module as the project default. Update and fix ESLint configuration.
- Renames JavaScript files in flux-build-scripts and api-docs/openapi/plugins to .cjs file extension to declare them as CommonJS module syntax.
2025-05-19 11:34:42 -05:00
Jason Stirnaman dce91b9692 hotfix(ent3): API ref: Remove admin token enterprise-only note and rebuild with previous fix. 2025-05-15 09:22:50 -05:00
Praveen Kumar db1b750cde
fix: url fixes in API reference section
- removes extra `/enterprise` in 'create admin token' section
- removes extra `/enterprise` in 'regenerate admin token' section
2025-05-15 12:13:31 +01:00
Praveen Kumar b816dbbfb6
fix: incorrect enterprise admin token creation link
This commit fixes the link by removing `/enterprise/` in the URL for creating admin token in enterprise

Both core and enterprise share the same endpoints mounted at the root
level for managing admin/operator token. Only enterprise specific
features are mounted on `/enterprise`.
2025-05-14 14:46:06 +01:00
Jason Stirnaman 815514c53b
Apply suggestions from code review 2025-05-09 10:24:58 -05:00
Jason Stirnaman 585490b983
Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-05-09 10:22:47 -05:00
Jason Stirnaman 504e7b3d1c feat(dedicated): Admin UI: Add create table, revise create database and custom partitioning
- Add Admin UI instructions for creating a table
- Moves database and table instructions for custom partitioning to separate tab groups
- Revise custom partitioning instructions for consistency.
- Add descriptions and links to Management API ref
2025-05-08 16:24:29 -05:00
Jason Stirnaman c4d4efc121 fix(influxdb3): unresolved product-name shortcode in frontmatter title, broken links to non-existent Core and Enterprise compatibility guides, alias api/v1 and api/v2 paths as api/v3. 2025-05-01 11:17:10 -05:00
Jason Stirnaman 49acdbabd7 fix(influxdb3): Apply corrections from code review 2025-04-21 15:41:03 -05:00
Jason Stirnaman 487a6d046b feat(influxdb3): Core and Enterprise: update API references:
- Add token management endpoints
- Update auth traitTag content
- Revise tags
- Add cache information
- Add Cache data tag group
- Remove Data I/O tag group
- Add Query data and Write data tags
2025-04-21 13:49:49 -05:00
Jason Stirnaman c8bc364b49 chore(influxdb3): API ref: Add auth information and token regenerate endpoints 2025-04-21 09:57:26 -05:00
Jason Stirnaman c259a01937 fix(api): replace alpha with beta 2025-04-09 11:05:38 -05:00
Jason Stirnaman 15cda93d28 fix(api-docs): Ask AI hides menu toggle at 800px
Increase the mediaQuery breakpoint for AskAI to avoid covering the menu toggle.
2025-03-17 13:12:11 -05:00
Jason Stirnaman 9932ea84e5 fix(api): don't ignore .config.yml files inside of api-docs 2025-03-17 12:10:13 -05:00
Jason Stirnaman 6b82aa2e62
Merge pull request #5898 from influxdata/jts/update-examples-and-pe-cache
Jts/update examples and pe cache
2025-03-17 08:21:16 -05:00
Jason Stirnaman 081a5ed02e
Merge pull request #5895 from influxdata/pbarnett/update-examples-and-pe-cache
Updates for new cluster configurations in Enterprise and new in-memory cache
2025-03-17 01:42:28 -05:00
Jason Stirnaman 3bf5f48cf8 fix(monolith): Core and Enterprise Beta fixes and cleanup 2025-03-17 01:38:49 -05:00
Jason Stirnaman 16567e2a1f fix(api): Ask AI button obstructs Redoc toggle:
- For small devices, positions the Ask AI button up above the Redoc menu button.
- I'd prefer to move the Redoc menu button up instead, but their docs don't mention position settings.
- Ensures AskAI is loaded after DOMContentLoaded.
2025-03-16 22:44:39 -05:00
Peter Barnett ef40b6ae0f update: adjust for new parameters, cluster configuration, modes, and some grammar 2025-03-16 22:05:33 -05:00
Jason Stirnaman 3d4f78f5c4 fix(cloudv2): Doesn't support environment references in templates 2025-03-14 18:11:16 -05:00
Jason Stirnaman d53330d503 hotfix: whitespace in generated files 2025-03-06 12:05:44 -06:00
Jason Stirnaman 09c3701912 fix(v3): influxdb3/core/api, influxdb3/enterprise/api Port data flow steps:
Apply suggestions from @hiltontj.
List data flow steps ported from 0fdd0efa0.
Use enum for field column types.
2025-03-06 11:34:21 -06:00
Jason Stirnaman 632878d945
Update api-docs/influxdb3/core/v3/ref.yml 2025-03-05 16:49:48 -06:00
Jason Stirnaman 7502ede123
Update api-docs/influxdb3/core/v3/ref.yml 2025-03-05 16:49:42 -06:00
Jason Stirnaman 7a1ad401d0
Update api-docs/influxdb3/core/v3/ref.yml 2025-03-05 16:49:27 -06:00
Jason Stirnaman cb953b9f63
Apply suggestions from code review
Co-authored-by: Trevor Hilton <trevor.hilton@gmail.com>
2025-03-05 16:49:05 -06:00
Jason Stirnaman 0b4d4a466e
Update api-docs/influxdb3/core/v3/ref.yml
Co-authored-by: Trevor Hilton <trevor.hilton@gmail.com>
2025-03-05 14:56:01 -06:00
Jason Stirnaman ed42c1e082
Update api-docs/influxdb3/core/v3/content/info.yml 2025-03-04 16:34:57 -06:00
Jason Stirnaman 5c196480f9
Update api-docs/influxdb3/enterprise/v3/ref.yml 2025-03-04 16:34:51 -06:00
Jason Stirnaman 40d2e0f938
Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-03-04 16:34:27 -06:00
Jason Stirnaman 4887aa5b66 fix(api): links and headings in local API refs.
- 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.
2025-02-26 16:20:14 -06:00
Jason Stirnaman bd93174d29 fix(api): confusing nav behavior with endpoints duplicated among tag groups. Closes Remove tag groups from API ref docs that duplicate endpoints in the "All endpoints" tag group. #5868 2025-02-26 16:14:37 -06:00
Jason Stirnaman 884bfd10ec feat(api): Add Ask AI widget to API ref docs
- 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.
2025-02-26 16:12:13 -06:00
Jason Stirnaman 4194ef5eb9 fix(api): Add shortDescription to replace summary
- 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
2025-02-26 16:07:28 -06:00
Jason Stirnaman f0245e32f5 feat(api-ref): API reference for Core and Enterprise 2025-02-25 17:10:29 -06:00
Jason Stirnaman 789c6fbe2f fix(api): Core: revise tags and tag-groups, add trait tags 2025-02-25 17:10:29 -06:00
Jason Stirnaman b3bb9c40f1 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.
- Remove generated HTML files.
2025-02-25 17:10:09 -06:00
Jason Stirnaman 846d3a9e46 fix(api): Update glossary links. Remove old cloud-serverless directory 2025-02-25 17:10:09 -06:00
Jason Stirnaman b6adbbf829 fix(api): Only call Google Tag Manager if hostname has influxdata.com - prevents undefined GTM object errors in dev
- Stub Google Tag Manager in the test
2025-02-25 17:09:32 -06:00
Jason Stirnaman 235b172734 fix(api): Skip to next api-docs directory if the current dir doesn't contain a .config.yml OpenAPI config 2025-02-25 17:09:32 -06:00
Jason Stirnaman f15d7857a9 chore(monolith): Core HTTP API and OpenAPI .info content for Core and Enterprise 2025-02-25 17:09:03 -06:00
Jason Stirnaman 4314589c07 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.
- Add and remove components
- Update parameters
- Add examples
- Add tests for Core
2025-02-25 17:08:05 -06:00
Peter Barnett f11461a419 Update API reference documentation 2025-02-25 12:07:42 -06:00
Jason Stirnaman b5cda5ce15 hotfix(api): update header back link for new product structure 2025-02-19 16:06:25 -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
Paul Dix 9ed11bc770
Merge branch 'master' into pd/influxdb3-plugins-doc 2025-01-31 10:07:44 -05:00