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

SpaceAbout: additional fields #4992

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

SpaceAbout: additional fields #4992

wants to merge 2 commits into from

Conversation

techsmyth
Copy link
Member

@techsmyth techsmyth commented Feb 27, 2025

Extend SpaceAbout to have additional fields exposed on this entity.

Goal is that all information that should be accessed on private spaces by non-members should be retrieved via this route.

This approach addresses a number of issues:

  • there is no leakage of information that really should be externally accessed e.g. all settings
  • the client just needs to query a spaceAbout, not all the containing entities such as collaboration, community etc.
  • authorization can be much simpler (and likely also faster)
query {
  spaces {
    about {
      id
      profile {
        displayName
      }
      provider {
        id
				nameID
      }
      metrics {
        name
        value
      }
      membership {
        myPrivileges
        applicationForm {
          questions {
            question
          }
        }
        myMembershipStatus
      }
    }
  }
}

giving

{
  "data": {
    "spaces": [
      {
        "about": {
          "id": "736bd3ef-c224-4fbe-827d-58a860714e7e",
          "profile": {
            "displayName": "Default Space"
          },
          "provider": {
            "id": "cb2ab7d3-3d40-4311-92d1-a791f170976f",
            "nameID": "eco1host"
          },
          "metrics": [
            {
              "name": "members",
              "value": "0"
            }
          ],
          "membership": {
            "myPrivileges": [],
            "applicationForm": {
              "questions": [
                {
                  "question": "What makes you want to join?"
                },
                {
                  "question": "Any particular role or contribution that you have in mind?"
                },
                {
                  "question": "Through which user,organization or medium have you become acquainted with this community?"
                },
                {
                  "question": "Anything fun you want to tell us about yourself?!"
                },
                {
                  "question": "Do you already want to join a Challenge? If so, please provide the name(s)."
                }
              ]
            },
            "myMembershipStatus": "NOT_MEMBER"
          }
        }
      }
    ]
  }
}

TODO / To discuss:

  • how to let users they can apply/join if not logged in? i.e. first create an account and then see what you can do?
  • expose the settings that are important for external information e.g. the privacyMode (important to NOT expose all settings to all users like we currently do!). Maybe add a new enum for "ContentVisibleToNonMembers" or similar?
  • Expose the lead users + organizations: under a "contact" entity?

Copy link
Contributor

coderabbitai bot commented Feb 27, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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.

1 participant