Commit Graph

183 Commits (enterprise-license)

Author SHA1 Message Date
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
Jason Stirnaman 8509ea36d6 fix(api-ref): Update getswagger.sh destination paths to use the new directory structure when fetching spec files. Update the redocly plugin module path. 2025-01-28 12:31:47 -06:00
Jason Stirnaman f1d82f4b00 fix(api-docs): Update API reference directories and generation script for influxdb3 URL paths, update links and names in reference content 2025-01-28 10:53:07 -06:00
Paul Dix b78162d24c Add plugin documentation for Core and Enterprise 2025-01-19 18:07:40 -05:00
Scott Anderson a62f69ffaf
InfluxDB Clustered partial writes (#5594)
* updated status code information for partial writes

* docs: add environment variable tuning explanation (#5579)

* WIP clustered partial writes

* fixed yaml error

* fixed duplicate key in clustered api docs

* Apply suggestions from code review

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

* Update content/influxdb/clustered/admin/env-vars.md

* Apply suggestions from code review

* add placeholder release notes for next clustered version

* update clustered release notes, remove option license info

---------

Co-authored-by: Jack <56563911+jdockerty@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2024-09-27 09:30:39 -06:00
Jason Stirnaman 92b115b1b4 fix(api): Fix Cloud Dedicated /ping descriptions
- Cloud Dedicated /ping only reports querier, not ingester, health
- Update v1 docs API and client library recommendations.

Closes 5610
2024-09-25 16:31:55 -05:00
Ben Tasker bae9b0e1b0
docs: correct description of status codes (#5587)
* docs: correct description of status codes

* Update api-docs/cloud-dedicated/v2/ref.yml

Co-authored-by: Fraser Savage <fraser@savage.engineer>

* Update api-docs/cloud-dedicated/v2/ref.yml

Co-authored-by: Fraser Savage <fraser@savage.engineer>

* Apply suggestions from code review

Co-authored-by: Fraser Savage <fraser@savage.engineer>

---------

Co-authored-by: Fraser Savage <fraser@savage.engineer>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-09-03 14:17:07 -06:00
Fraser Savage 9f0c7c6283
refactor(write-api): Punctuation and wording changes from code review
This makes the changes more consistent with wider writing style.

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2024-09-03 15:37:02 +01:00
Fraser Savage 5d74f97926
fix(write-api): Partial writes now return a 400 response code in dedicated
This updates some of the other wording around the troubleshooting table
to reflect the product's current state more closely.
2024-09-02 17:52:40 +01:00
Fraser Savage 8305b7cde4
fix(write-api): Partial writes now return a 400 response code in serverless
This updates some of the other wording around the troubleshooting table
to reflect the product's current state more closely.
2024-09-02 17:47:40 +01:00
Fraser Savage e448b6a223
fix(write-api): Serverless write requests outside retention return 400
Partial writes are the only mode of operation on serverless clusters.
This means that any requests where all points are outside the retention
policy of a bucket receive a 400 bad request.
2024-09-02 16:50:34 +01:00
Fraser Savage 57eb8c6aa4
refactor(write-api): Use proper product terms for Dedicated
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-08-09 16:17:43 +01:00
Fraser Savage 749c59b525
fix(write-api): Update Cloud Dedicated outside-retention failure to HTTP 422 2024-08-09 15:51:18 +01:00
Fraser Savage c83339029c
fix(write-api): Update Cloud Serverless outside-retention failure to HTTP 422 2024-08-09 15:45:38 +01:00
Jacob Marble ef61afc6ec fix(write-api): Serverless write 201 response codes
Helps https://github.com/influxdata/idpe/issues/18710

InfluxDB v3 Serverless will soon return 201 or 204, in cases where it
currently returns 204.
2024-08-07 12:57:04 -07:00
Scott Anderson 5c7d3407ad
Update the placeholder URL for dedicated (#5527)
* update the placeholder URL for dedicated

* added dedicated URL migration
2024-07-22 16:55:00 -06:00