From 8e0e393f5209b0b7c8e49e641e5c2c6da957ff13 Mon Sep 17 00:00:00 2001 From: spiral Date: Fri, 22 Oct 2021 17:54:47 -0400 Subject: [PATCH] feat(apiv2): docs fixes --- PluralKit.API/Controllers/v2/SystemControllerV2.cs | 2 +- PluralKit.Core/Models/PKMember.cs | 2 +- docs/content/api/endpoints.md | 14 +++++++------- docs/content/api/models.md | 1 + 4 files changed, 10 insertions(+), 9 deletions(-) diff --git a/PluralKit.API/Controllers/v2/SystemControllerV2.cs b/PluralKit.API/Controllers/v2/SystemControllerV2.cs index 4cbcc1c0..b4ae8fc1 100644 --- a/PluralKit.API/Controllers/v2/SystemControllerV2.cs +++ b/PluralKit.API/Controllers/v2/SystemControllerV2.cs @@ -24,7 +24,7 @@ namespace PluralKit.API else return Ok(system.ToJson(this.ContextFor(system), v: APIVersion.V2)); } - [HttpPatch] + [HttpPatch("@me")] public async Task DoSystemPatch([FromBody] JObject data) { var system = await ResolveSystem("@me"); diff --git a/PluralKit.Core/Models/PKMember.cs b/PluralKit.Core/Models/PKMember.cs index 0ed739cb..caa9fcda 100644 --- a/PluralKit.Core/Models/PKMember.cs +++ b/PluralKit.Core/Models/PKMember.cs @@ -123,8 +123,8 @@ namespace PluralKit.Core o.Add("name", member.NameFor(ctx)); // o.Add("color", member.ColorPrivacy.CanAccess(ctx) ? member.Color : null); - o.Add("color", member.Color); o.Add("display_name", member.NamePrivacy.CanAccess(ctx) ? member.DisplayName : null); + o.Add("color", member.Color); o.Add("birthday", member.BirthdayFor(ctx)?.FormatExport()); o.Add("pronouns", member.PronounsFor(ctx)); o.Add("avatar_url", member.AvatarFor(ctx).TryGetCleanCdnUrl()); diff --git a/docs/content/api/endpoints.md b/docs/content/api/endpoints.md index ad378dbf..50606fc7 100644 --- a/docs/content/api/endpoints.md +++ b/docs/content/api/endpoints.md @@ -32,7 +32,7 @@ GET `/systems/@me/guilds/{guild_id}` Returns a [system guild settings](/api/models#system-guild-settings) object. -::: note +::: tip You must already have updated per-guild settings for your system in the target guild before being able to get or update them from the API. ::: @@ -91,7 +91,7 @@ GET `/members/{memberRef}/groups` PUT `/members/{memberRef}/groups` -::: warn +::: warning Not all HTTP implementations support PUT requests with a body. If yours does not, consider using the [Add Member To Group](#add-member-to-group) endpoint instead. ::: @@ -99,7 +99,7 @@ Not all HTTP implementations support PUT requests with a body. If yours does not DELETE `/members/{memberRef}/groups` -::: warn +::: warning Not all HTTP implementations support DELETE requests with a body. If yours does not, consider using the [Remove Member From Group](#remove-member-from-group) endpoint instead. ::: @@ -109,8 +109,8 @@ GET `/members/{memberRef}/guilds/{guild_id}` Returns a [member guild settings](/api/models#member-guild-settings) object. -::: note -You must already have updated per-guild settings for a member in the target guild before being able to get or update them from the API. +::: tip +You must already have updated per-guild settings for the target member in the target guild before being able to get or update them from the API. ::: ### Update Member Guild Settings @@ -172,7 +172,7 @@ PUT `/groups/{groupRef}/members/{memberRef}` PUT `/groups/{groupRef}/members` -::: warn +::: warning Not all HTTP implementations support PUT requests with a body. If yours does not, consider using the [Add Member To Group](#add-group-member) endpoint instead. ::: @@ -184,7 +184,7 @@ DELETE `/groups/{groupRef}/members/{memberRef}` DELETE `/groups/{groupRef}/members` -::: warn +::: warning Not all HTTP implementations support DELETE requests with a body. If yours does not, consider using the [Remove Member From Group](#remove-member-from-group) endpoint instead. ::: diff --git a/docs/content/api/models.md b/docs/content/api/models.md index ac771c13..fe0c7aef 100644 --- a/docs/content/api/models.md +++ b/docs/content/api/models.md @@ -80,6 +80,7 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID. |key|type|notes| |---|---|---| +|id|uuid|| |timestamp|datetime|| | members | list of id/Member | Is sometimes in plain ID list form (eg. `GET /systems/:id/switches`), sometimes includes the full Member model (eg. `GET /systems/:id/fronters`). |