influxdata / influxdata/openapi

Stack uninstall needs an orgID parameter not documented in cloud.json

Open
#323 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
18
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Latest commit

commit d44c6511bf23ce09d14c82d0baa139d90f444469 (HEAD -> master, origin/master, origin/HEAD)
Author: Yoofi Quansah <yqsummon@gmail.com>
Date:   Fri Apr 29 08:57:53 2022 -0700

While preparing Grace tests for the stacks endpoints, I've attempted using Postman to POST calls against the path stacks/{stack_id}/uninstall

In cloud.json

    "/stacks/{stack_id}/uninstall": {
      "post": {
        "operationId": "UninstallStack",
        "tags": [
          "Templates"
        ],
        "summary": "Uninstall a stack",
        "parameters": [
          {
            "in": "path",
            "name": "stack_id",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The identifier of the stack."
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the uninstalled stack.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Stack"
                }
              }
            }
          },
          "default": {
            "description": "Unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },

I attempted the following...

  https://twodotoh-dev-bonitoo-kk.remocal.influxdev.co/api/v2/stacks/0955fcf5748ef000/uninstall

Which returns "422 'you do not have access to given stack ID'"

However by adding an orgID parameter, I got the response described in the 'responses' section.

https://twodotoh-dev-bonitoo-kk.remocal.influxdev.co/api/v2/stacks/0955fcf5748ef000/uninstall?orgID=42e003dd4621bdb5

However the orgID parameter for this path is not mentioned in the cloud.json document.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open cloud.json and locate the POST definition for /stacks/{stack_id}/uninstall. Compare the documented parameters with the request that succeeds when orgID is supplied, then update the specification so the endpoint documents that parameter and verify the resulting definition matches the observed request.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.