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

Remove List types from API reference #637

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tvoran
Copy link
Member

@tvoran tvoran commented Mar 5, 2024

Set List types to be ignored in docs/api/config.yaml and ran make gen-api-ref-docs.

Just thinking this could make the API reference docs more clear as to which resources can be created.

Related to #635

Since they aren't used to create resources.
@tvoran tvoran added this to the v0.5.2 milestone Mar 5, 2024
@tvoran tvoran requested a review from a team as a code owner March 5, 2024 06:54
Copy link
Contributor

@tomhjp tomhjp left a comment

Choose a reason for hiding this comment

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

Makes sense to me 👍 one alternative I considered was whether we could make efforts to mark them as some form of read-only, but I think this way will cause less confusion for users.

@benashz benashz self-requested a review March 5, 2024 14:06
@benashz
Copy link
Collaborator

benashz commented Mar 5, 2024

I wonder if updating documentation for the the LIst types to say that they are for read-only operations would be a better way to go? That way our API reference would still be complete.

@tvoran tvoran removed this from the v0.5.2 milestone Mar 13, 2024
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.

None yet

3 participants