Commit Graph

9 Commits (feat/rapidoc-api-docs)

Author SHA1 Message Date
Scott Anderson 460e80229a
fix JSON syntax error in bucket create example, closes influxdata/DAR#261 (#3535) 2022-01-04 15:52:46 -07:00
kelseiv 5ffaff1c67
invokable (#3405)
* invokable

* update filename and add alias

* fix: rename samples to api-invokable-scripts

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-11-16 12:05:07 -08:00
Scott Anderson 935422b74a
updated token naming and other typos, closes influxdata/DAR#244 (#3309) 2021-10-26 12:23:44 -06:00
Jason Stirnaman a6254e1e79
Fix api invocable (#3306)
* fix: scripts api path.

* fix: bad comma

* feat: add invocable scripts example for sending multiple parameter values.
2021-10-26 08:48:08 -05:00
Jason Stirnaman 6587ee1fdc
Document new API Invocable Scripts feature (was named-functions) (#3282)
* feat: add api-guides/guides and guides/api-invocable-scripts for the API-invocable scripts (managed functions) feature (##2547, #2233).

* feat: document API-invocable scripts. Add example for creating and invoking a script with POST. Unable to make GET work with query parameters.

* feat: moved API-invocable scripts under api-guide. Remove guides directory. Add docs for list and find. Add example for list. Add shortcuts and glossary links. Verified with team-compute that GET /invoke and python are not supported yet.

* feat: rename example function for simplicity since there's no GET for now.

* feat: add find_and_update example (#2547).

* feat: add update example. Clarify, expand invoke example. Add links. (#2547)

* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix: remove accidental commit of generated redoc-static.html

* feat: manual update to cloud swagger. Merges meta, auth, tags, and x-tagGroups from src/cloud.yml to aggregate contracts/ref/cloud.yml.

* fix: replace /functions with /scripts

* feat: get swaggers from contracts/ref. Still requires copy-paste of info, tags, and auth from contracts/cloud.yml and contracts/oss.yml

* feat: invocable scripts (#2547)

* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* feat: new section for params (#2547).

* fix: swagger server url (#2547)

* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* feat: remove jq and function where there's no clear need.

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2021-10-25 08:30:31 -05:00
Jason Stirnaman 22cf8ccadc
API examples and client guide updates (#3106)
* feat: troubleshoot write errors (#3003). Fix link in Flux reference.

* fix: make placeholders consistent and conform to style guide.

* fix: Node.js client. Delete unused files (#3003)

* Node.js client. Add examples.

* fix: gzip instructions for API with curl.

* fix: Node.js client guide. Query guide fixes. Frontmatter fixes.

* fix: API client frontmatter consistency. Use language for title so <children> list is sorted properly.

* Update content/influxdb/v2.0/api-guide/client-libraries/nodejs/install.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/v2.0/api-guide/client-libraries/nodejs/write.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/v2.0/api-guide/client-libraries/nodejs/write.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/v2.0/api-guide/client-libraries/nodejs/query.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix: customize example URLs (closes #3113)

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-09-13 11:08:02 -05:00
Jason Stirnaman 209f563cfb
View, create, and use tokens with the API (#3049)
* fix: broken links in Use Tokens

* feature: add Create and View Tokens with the API

* update: View, create, and use tokens with the API. Add command-line, curl examples. (#1541)

* Update content/influxdb/v2.0/api-guide/api_intro.md

* Update token description

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2021-08-23 11:05:07 -05:00
Jason Stirnaman b39bf036e0
fixes API guide changes, create-bucket, aliases (#2860)
* fix: fix broken link by adding API guide for creating a bucket.  - add example code.  - add aliases for pages moved from Tools.
* fix: move create a bucket into the existing page for now. Copy example to API quick start.

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-07-16 16:23:21 -05:00
Jason Stirnaman 5868957535
Fix shared files (#2856)
* fix: negate check for verbose.

* fix: default version directory to latest version.

* update: API changes.

* update: API updated with grammar fixes

* fix: move assets/text to shared/text
2021-07-15 17:21:52 -05:00