Add domain_data to Organizations Create and Update methods to replace domains
#291
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mthadley
requested review from
a team and
marktran
and removed request for
a team
These assertions don't really care about the internal behavior of `WorkOS::Deprecation`.
cmatheson
approved these changes
Apr 30, 2024
| # @option domain_data [String] domain The domain that belongs to the organization. | ||
| # @option domain_data [String] state The state of the domain. "verified" or "pending" | ||
| # @param [Array<String>] domains List of domains that belong to the organization. | ||
| # Deprecated: Use domain_data instead. |
There was a problem hiding this comment.
is this deprecation notice supposed to be attached to the old domains param? (i think we lost that one?)
There was a problem hiding this comment.
Yeah, it should be associated with domains:
# @param [Array<String>] domains List of domains that belong to the organization.
# Deprecated: Use domain_data instead.Maybe it looks a bit weird since it is on the next line, indented, as a separate "paragraph". Is that the right way to document it in Ruby?
There was a problem hiding this comment.
ohhh, i don't know how i wasn't seeing that earlier. yeah this looks right to me 👍
mthadley
deleted the
feature/auth-2969-ruby-add-domains_data-to-sdks-and-deprecate-domains
branch
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds a new
domain_dataparameter to be passed to Organization create and update calls, instead of thedomainsparameter which will be soon deprecated.While I was in here I also cleaned up some noise and warnings when running the specs, and also unified the way we were calling
warninto a sharedWorkOS::Deprecationmodule.Documentation
Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.
If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.