Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): update PostDBRP docs to reflect mutual exclusive requirement of org vs orgID #19802

Merged
merged 1 commit into from
Oct 22, 2020

Conversation

GeorgeMac
Copy link
Contributor

I am unsure if I am doing this correctly. But this updates the PostDBRP docs to reflect the mutually exclusive requirement of org vs orgID when creating a DBRP mapping. Since only one or the other is actually required to create the mapping. But the docs currently state both are required.

My knowledge of OpenAPI Spec is a little lacking. But this is what I assertain is correct based on good old SO:

https://stackoverflow.com/questions/21134029/how-to-define-mutually-exclusive-query-parameters-in-swagger-openapi/49199240#49199240

  • CHANGELOG.md updated with a link to the PR (not the Issue)
  • Well-formatted commit messages
  • Rebased/mergeable
  • Tests pass
  • http/swagger.yml updated (if modified Go structs or API)
  • Feature flagged (if modified API)
  • Documentation updated or issue created (provide link to issue/pr)
  • Signed CLA (if not already signed)

@GeorgeMac GeorgeMac requested a review from a team as a code owner October 22, 2020 11:19
@GeorgeMac GeorgeMac requested review from TCL735 and removed request for a team October 22, 2020 11:19
@rbetts rbetts self-requested a review October 22, 2020 12:49
Copy link
Contributor

@rbetts rbetts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was less intuitive than I imagined! Thanks for linking the SO answer 😂.

@GeorgeMac
Copy link
Contributor Author

@rbetts I know right? I stumbled across some old issues which said it wasn't possible in OAPI 2.0 and was concerned I would have to just settle on a description. But 🤞 this will do it. Thanks for the review!

@GeorgeMac GeorgeMac merged commit 3b7cb52 into master Oct 22, 2020
@GeorgeMac GeorgeMac deleted the gm/post-dbrp-org-mutual-exclusion branch October 22, 2020 16:02
@sranka
Copy link
Contributor

sranka commented Dec 16, 2020

@GeorgeMac FYI : This PR did the job that is compliant with the spec. The influxdb UI's oats (typescript code generator) generates useless export type DBRP = any | any, ... I will fix it for influxdata/influxdb-client-js . Other API generators will likely create a type/class with all properties being optional.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants