fix: clarify organization_id and add import examples #259
+139
−3
Conversation
This file contains hidden or 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
JEETDESAI25
force-pushed
the
fix/issue-218-doc-org-id-import
branch
from
551e1b7 to
9c162f2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What kind of change does this PR introduce?
Documentation improvement
What is the current behavior?
Closes #218
The
organization_idparameter lacks clarity, users don't know it refers to the organization slug found in the dashboard URL. Additionally, import documentation is missing for all resources (project, settings, branch).What is the new behavior?
organization_idschema description to specify it's the organization slugAdditional context
Regenerated docs via
go generate ./.... Minor merge conflict possible with PR #255 in project_resource.go (both changes should be kept).