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

Add "public" metadata section in project's metadata and use it for display name #2702

Merged
merged 1 commit into from
Mar 18, 2024

Conversation

JAORMX
Copy link
Contributor

@JAORMX JAORMX commented Mar 18, 2024

Summary

This adds a public metadata key in the project's metadata. This will hold whatever is fine
to display for the project in an API/UI. The first two instances added there are the description
(previously unused) and the "display name".

The display name is always displayed and defaulted to the project's name. It is also defaulted
in all new projects.

It should show up as follows:

$ minder project list -o json
WARNING: Running against a test environment (127.0.0.1) and may not be stable
{
  "projects": [
    {
      "projectId": "73460926-70c3-4d7d-bf34-1c224a1ec4d4",
      "name": "jaormx",
      "createdAt": "2024-03-18T16:18:19.521054Z",
      "updatedAt": "2024-03-18T16:18:19.521054Z",
      "displayName": "jaormx"
    }
  ]
}

Adding the ability to update a project will come in a subsequent PR.

Change Type

Mark the type of change your PR introduces:

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)

Testing

Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • Included tests that validate the fix or feature.
  • Checked that related changes are merged.

@JAORMX JAORMX requested a review from a team as a code owner March 18, 2024 16:30
@coveralls
Copy link

coveralls commented Mar 18, 2024

Coverage Status

coverage: 46.665% (+0.06%) from 46.601%
when pulling 3d9f432 on display-name
into 8a0bc3f on main.

@JAORMX JAORMX merged commit a5e688f into main Mar 18, 2024
20 checks passed
@JAORMX JAORMX deleted the display-name branch March 18, 2024 19:09
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.

3 participants