Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

chore: correct template API docs#19228

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
phorcys420 merged 10 commits intomainfromphorcys420/fix-template-api-docs
Aug 19, 2025

Conversation

phorcys420
Copy link
Member

@phorcys420phorcys420 commentedAug 7, 2025•
edited
Loading

  • I used thecodersdk.UpdateTemplateMeta type, because it seemed like the most appropriate type fromcodersdk/templates.go, I made that decision based on howpatchOrganization inenterprise/coderd/organizations.go
    // @Param request body codersdk.UpdateOrganizationRequest true "Patch organization request"
    usescodersdk.UpdateOrganizationRequest
  • I made thebody required in the docs even though it isn't actually enforced (i.e an empty body works on that endpoint), I don't know if we should enforce it
  • I have renamed "metadata" to "settings" so that it is more coherent with the wording in the UI, but that creates additionnal inconsistencies in logging and internal IDs that should probably be fixed at some point to make debugging easier.

@phorcys420phorcys420 marked this pull request as draftAugust 7, 2025 12:18
@phorcys420
Copy link
MemberAuthor

phorcys420 commentedAug 7, 2025•
edited
Loading

phorcys420and others added2 commitsAugust 7, 2025 16:36
Co-authored-by: Dean Sheather <dean@deansheather.com>
Copy link
Member

@deansheatherdeansheather left a comment

Choose a reason for hiding this comment

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

Looks good from a sound-ness perspective. I think Atif or Ben should sign off on the route name change, though

@phorcys420
Copy link
MemberAuthor

phorcys420 commentedAug 7, 2025•
edited
Loading

fyi Atif/Ben, I have renamed the "template metadata" wording to "template settings" in API docs as that is the wording we use in the UI, and one of my customers was confused about this, we just want your opinion on this.
image

@phorcys420phorcys420 marked this pull request as ready for reviewAugust 7, 2025 14:43
Copy link
Member

@matifalimatifali left a comment•
edited
Loading

Choose a reason for hiding this comment

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

LGTM from the UX perspective as we list them under Settings in the UI.

@phorcys420phorcys420enabled auto-merge (squash)August 8, 2025 17:42
@github-actionsgithub-actionsbot added the staleThis issue is like stale bread. labelAug 16, 2025
@github-actionsgithub-actionsbot removed the staleThis issue is like stale bread. labelAug 17, 2025
@phorcys420phorcys420 merged commitb6abcba intomainAug 19, 2025
46 of 49 checks passed
@phorcys420phorcys420 deleted the phorcys420/fix-template-api-docs branchAugust 19, 2025 15:14
@github-actionsgithub-actionsbot locked and limited conversation to collaboratorsAug 19, 2025
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers

@matifalimatifalimatifali approved these changes

@deansheatherdeansheatherdeansheather approved these changes

@bpmctbpmctAwaiting requested review from bpmct

Assignees

@phorcys420phorcys420

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

3 participants
@phorcys420@matifali@deansheather
[8]ページ先頭
©2009-2025 Movatter.jp