Commit Graph

7 Commits (274d4a0444b249bb7dcefc9592fc75ce9eef55db)

Author SHA1 Message Date
Jason Stirnaman f431862a4a
Fix api version (#4697)
* chore: remove unused and deprecated properties:

- Remove unused apis key.
- Remove deprecated styleguide property, replace with root-level plugins and extends.

* chore: pass api-docs path to the custom plugin:

- Pass pwd of the calling script as process.env.API_DOCS_ROOT_PATH to plugins to help resolve custom content files.
- Remove lint execution because the exit code always results in execution of the next elif condition.

* chore: simplify api-docs custom content:

- move content overrides from api-docs/openapi/content to api-docs/[version]/content.
- fix version and version numbers in links.
- update cloud and v2.6 from openapi repo.
- move content.js module to docs-content.js and docs-plugin.js.
- revert decorator functions back to taking content as a data argument.
- remove unused servers.yml definition.

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-01-11 13:03:21 -07:00
Jason Stirnaman 22b0fe769b
chore(api): update Cloud and v2.3 API specs with latest openapi updates. (#4265)
Cloud: 0cb1ba2
OSS: 95559e3737b24f40bd0d90ea49f0dfbf84eea371
2022-07-28 16:21:09 -05:00
Sunbrye Ly 01cec20b96 hotfix:400-error 2022-07-21 12:52:37 -07:00
Jason Stirnaman b15f2fdfdc
Api/update specs (#4226)
* chore(api): update specs

- tasks with scripts for cloud
- improve task endpoint docs

* chore: update cloud and oss api specs for cloud tasks-with-scripts.

- Tasks can be used with invokable scripts.
- Reset docs-release/oss branch to head of master due to changes for
  tasks. Doesn't appear to be anything new in OSS that would break.
2022-07-19 14:58:35 -05:00
Jason Stirnaman 72c31b5d12
Chore/upgrade hugo (#4164)
* fix: Upgrade Hugo and CSS dependencies to fix code samples

Upgrade to latest version of hugo-extended.
Upgrade to latest compatible version of PostCSS.
Fixes syntax highlighting for JavaScript code samples.

* chore: add openapi elements and reimplement Regex to replace shortcode.
2022-06-28 16:17:05 -05:00
Jason Stirnaman 88d3057f21
fix(api): reimplement Regex to replace shortcode. (#4161)
* fix(api): reimplement Regex to replace shortcode.

- Update README with more detailed instructions for updating API docs.
- Use regular expression instead of string to replace URL shortcode, just in case of extra whitespace or line breaks.
- Look for shortcode in additional nodes, especially Parameters.
- Regenerate docs with URL shortcode replacement.

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/openapi/plugins/decorators/replace-shortcodes.js

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2022-06-27 08:53:32 -05:00
Jason Stirnaman d6b4f8cf04
chore: add OSS v2.3 API docs. (#4152) 2022-06-22 15:36:39 -07:00