Commit Graph

6177 Commits (jts/api-uplift)

Author SHA1 Message Date
Jason Stirnaman 6df73de175 To build the API pages, run `yarn run build-apidocs` from the project directory.
No longer uses Hugo /data.
Removes dependency on the Hugo-data-to-pages script.
For each product endpoint, generate a page with the endpoint spec inside the frontmatter.
Writes endpoint specs into each page's frontmatter.
Assign a `type` property for API reference (OpenAPI) paths. For example, if the page structure is `content/influxdb/v2/api/v2/[OpenAPI path]`, then add `type: api_path` to the frontmatter and, if necessary, specify a layout: `layout: api_path`.
Renders the spec param JSON using Rapidoc.

TODO:
- Cleanup
- Create additional templates that process page data for nav, filtering, links, code samples, etc.
- Fix circular reference issues in specs that prevent generating a dereferenced JSON bundle (which could also help us our own custom UI...should we choose).
2025-03-04 17:08:33 -06:00
Jason Stirnaman 0091f3b024 WIP: draft TODO. Simplify code. 2025-03-04 17:08:33 -06:00
Jason Stirnaman c5dd3e3d32 To build the API pages, run `yarn run build-apidocs` from the project directory.
No longer uses Hugo /data.
Removes dependency on the Hugo-data-to-pages script.
For each product endpoint, generate a page with the endpoint spec inside the frontmatter.
Writes endpoint specs into each page's frontmatter.
Assign a `type` property for API reference (OpenAPI) paths. For example, if the page structure is `content/influxdb/v2/api/v2/[OpenAPI path]`, then add `type: api_path` to the frontmatter and, if necessary, specify a layout: `layout: api_path`.
Renders the spec param JSON using Rapidoc.

TODO:
- Cleanup
- Create additional templates that process page data for nav, filtering, links, code samples, etc.
- Fix circular reference issues in specs that prevent generating a dereferenced JSON bundle (which could also help us our own custom UI...should we choose).
2025-03-04 16:45:08 -06:00
Jason Stirnaman 807ee73fe2 WIP: draft TODO. Simplify code. 2025-03-04 16:45:08 -06:00
Jason Stirnaman 1654d3c4f3
Merge branch 'master' into core-enterprise-api-ref 2025-03-04 16:36:46 -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
Jameelah Mercer 10bece946a
Merge branch 'master' into docs/v3/docker-port-update-5826 2025-03-04 12:45:24 -08:00
antonmeyer fe09b06fcb
Update hour.md with example for local time (#5873)
* Update hour.md with example for local time

Update hour.md with example for local time

* Update content/flux/v0/stdlib/date/hour.md

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-03-04 10:04:02 -07:00
Jason Stirnaman 5fe70a938a
Update content/telegraf/v1/install.md 2025-03-04 10:38:19 -06:00
Jason Stirnaman f628d3ad5e
Update content/telegraf/v1/configuration.md 2025-03-04 10:38:12 -06:00
Jason Stirnaman 4de177cb81
Update content/telegraf/v1/install.md 2025-03-04 10:38:06 -06:00
Jason Stirnaman 36ae6d0fac
Update content/telegraf/v1/configuration.md 2025-03-04 10:37:57 -06:00
Jason Stirnaman b040ba2b3e
Update content/shared/v3-core-get-started/_index.md 2025-03-04 10:24:00 -06:00
Jason Stirnaman d069769cd0
Update content/influxdb3/core/install.md 2025-03-04 10:23:37 -06:00
Jason Stirnaman a843d75057
Update content/shared/v3-core-get-started/_index.md 2025-03-04 10:21:08 -06:00
Jason Stirnaman a54ebf9ba8
Update content/influxdb3/core/install.md 2025-03-04 10:21:03 -06:00
Jameelah Mercer ed5ad593aa
Update _index.md
trail two of fixing merge conflict
2025-02-28 14:40:07 -08:00
Jameelah Mercer addbf2768f
conflict update 2025-02-28 14:26:59 -08:00
meelahme ed7c48bb88 Adding docker note to Core install guide 2025-02-28 14:20:14 -08:00
meelahme 95a3b0d6e8 Resolved merge conflicts 2025-02-28 14:12:01 -08:00
meelahme ec6d5bd951 update to note 2025-02-28 13:56:59 -08:00
Jameelah Mercer ba44ebfe5c
Update content/shared/v3-core-get-started/_index.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-02-28 13:53:53 -08:00
Swayam Sharma 4467afff3c
fix broken links in install.md 2025-03-01 03:16:20 +05:30
Swayam Sharma a77a5950bb
fix broken links in configuration.md 2025-03-01 03:13:22 +05:30
meelahme e4d66111fc Adding a port exposure note to Core get started page (#5862) 2025-02-27 19:22:15 -08:00
Jason Stirnaman 4403dd9a18 fix: LInks and headings. Replace `latest` with `v2`. Specify OSS v2 in headings. Closes fix(api-refs): specify v2 in InfluxDB OSS headings #5866, Closes Flux docs: replace `/influxdb/latest` with `/influxdb/v2` #5864. Linting cleanup, removing terminal prompt from examples 2025-02-27 17:50:16 -06:00
Jason Stirnaman f0245e32f5 feat(api-ref): API reference for Core and Enterprise 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 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
Jason Stirnaman 3cae4779b7
Merge branch 'master' into clustered-upgrade-notes 2025-02-25 10:57:42 -06:00
Jason Stirnaman d7200f1363 chore(sql): how ranking functions handle duplicate values
- Add query example with output from @appletreeisyellow
- Clarify function descriptions
2025-02-25 10:06:09 -06:00
Jason Stirnaman 86c4c35f77
Merge branch 'master' into sql-window-functions 2025-02-24 17:52:02 -06:00
Jason Stirnaman 5b42d3a012 fix: terms and formatting in monolith get-started and plugins. Add related links. 2025-02-24 17:45:51 -06:00
Jason Stirnaman 971562275f hotfix: codeblock 2025-02-24 17:20:29 -06:00
Jason Stirnaman 002074bd10 fix: On Request configuration 2025-02-24 17:14:53 -06:00
Jason Stirnaman 6a5aeb3cfc fix: Processing engine description. 2025-02-24 16:49:29 -06:00
Jason Stirnaman 90eb51e447 fix(v3): Core and Enterprise Get Started: fix bad interval syntax, update processing engine overview
- Fix interval syntax mentioned in https://influxdata.slack.com/archives/C084G9LR2HL/p1740171190161249.
- Update processing engine overview and link to guide.
2025-02-24 16:28:38 -06:00
Jason Stirnaman d8d1d09290
Update content/shared/v3-core-plugins/_index.md 2025-02-24 14:43:23 -06:00
Jason Stirnaman 49c055fd0b
Update content/shared/v3-core-plugins/_index.md 2025-02-24 14:43:15 -06:00
Jason Stirnaman 4f5122da92
Update content/shared/v3-core-plugins/_index.md 2025-02-24 14:42:35 -06:00
Jason Stirnaman 5976a64844
Update content/shared/v3-core-plugins/_index.md 2025-02-24 14:42:19 -06:00
Jason Stirnaman 72d078ffba
Update content/shared/v3-core-plugins/_index.md 2025-02-24 14:42:11 -06:00
Jason Stirnaman 28018666a4
Apply suggestions from code review 2025-02-24 14:40:35 -06:00
Jason Stirnaman c5b8bb2663
Merge branch 'master' into pbarnett/processing-engine-updates 2025-02-24 14:04:29 -06:00
Jason Stirnaman ba7f10944a feat(sql): Add Window aggregate and Ranking functions to SQL reference index 2025-02-24 13:37:15 -06:00
Jason Stirnaman 01236c6791 fix(sql): Apply suggestions from code review. 2025-02-24 13:35:41 -06:00
Jason Stirnaman b7dee87b03
Update content/enterprise_influxdb/v1/administration/configure/config-data-nodes.md 2025-02-24 10:03:10 -06:00
Jason Stirnaman 3b346d927d
Update content/enterprise_influxdb/v1/administration/configure/config-data-nodes.md 2025-02-24 10:03:03 -06:00
Jason Stirnaman da0cfc1871
Update content/enterprise_influxdb/v1/administration/configure/config-data-nodes.md 2025-02-24 10:01:53 -06:00
Jason Stirnaman cbe67338e5
Update content/enterprise_influxdb/v1/administration/configure/config-data-nodes.md 2025-02-24 10:01:46 -06:00