linode-cli icon indicating copy to clipboard operation
linode-cli copied to clipboard

new: Point at TechDocs OpenAPI spec location; add support for loading JSON specs

Open lgarber-akamai opened this issue 1 year ago • 0 comments

📝 Description

NOTE: This PR will be marked as do-not-merge until the TechDocs spec is available in the akamai-apis repo. Until then, it still should be ready to review.

This pull request points the CLI's default OpenAPI spec target at the new bundled TechDocs spec.

To support loading the new OpenAPI spec, this PR includes the following changes:

  • Rework baking logic to support loading JSON specs in addition to YAML specs.
  • Remove resolve_spec_url script as it is no longer needed.
    • Remove GITHUB_TOKEN references in CI workflows and Dockerfiles.

✔️ How to Test

The following test steps assume you have pulled down this PR locally.

Installing with the TechDocs OpenAPI spec (JSON):

make SPEC="https://gist.githubusercontent.com/lgarber-akamai/1c84a451231195d63e990a89f45788fc/raw/3d4c6c677c06bd28d90ec6dd994c7305da0839af/openapi-new.json" install

Installing with the Legacy OpenAPI spec (YAML):

make SPEC="https://raw.githubusercontent.com/linode/linode-api-docs/development/openapi.yaml" install

Integration Testing

make testint

Unit Testing

make testunit

Manual Testing

Manual testing can be done by simply running linode-cli commands after running one of the above installation commands.

lgarber-akamai avatar Jul 24 '24 20:07 lgarber-akamai