From fc3741365c27f1d703e8a736af95b95ff811cc45 Mon Sep 17 00:00:00 2001 From: Vyr Cossont Date: Wed, 6 Mar 2024 09:05:45 -0800 Subject: [bugfix] Fix Swagger spec and add test script (#2698) * Add Swagger spec test script * Fix Swagger spec errors not related to statuses with polls * Add API tests that post a status with a poll * Fix creating a status with a poll from form params * Fix Swagger spec errors related to statuses with polls (this is the last error) * Fix Swagger spec warnings not related to unused definitions * Suppress a duplicate list update params definition that was somehow causing wrong param names * Add Swagger test to CI - updates Drone config - vendorizes go-swagger - fixes a file extension issue that caused the test script to generate JSON instead of YAML with the vendorized version * Put `Sample: ` on its own line everywhere * Remove unused id param from emojiCategoriesGet * Add 5 more pairs of profile fields to account update API Swagger * Remove Swagger prefix from dummy fields It makes the generated code look weird * Manually annotate params for statusCreate operation * Fix all remaining Swagger spec warnings - Change some models into operation parameters - Ignore models that already correspond to manually documented operation parameters but can't be trivially changed (those with file fields) * Documented that creating a status with scheduled_at isn't implemented yet * sign drone.yml * Fix filter API Swagger errors * fixup! Fix filter API Swagger errors --------- Co-authored-by: tobi --- internal/api/model/rule.go | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) (limited to 'internal/api/model/rule.go') diff --git a/internal/api/model/rule.go b/internal/api/model/rule.go index f4caf7dd0..b94c502c5 100644 --- a/internal/api/model/rule.go +++ b/internal/api/model/rule.go @@ -27,15 +27,24 @@ type InstanceRule struct { // InstanceRuleCreateRequest represents a request to create a new instance rule, made through the admin API. // -// swagger:model instanceRuleCreateRequest +// swagger:parameters ruleCreate type InstanceRuleCreateRequest struct { - Text string `form:"text" validation:"required"` + // Text body for the instance rule, plaintext. + // required: true + // in: formData + Text string `form:"text" json:"text" validation:"required"` } // InstanceRuleUpdateRequest represents a request to update the text of an instance rule, made through the admin API. // -// swagger:model instanceRuleUpdateRequest +// swagger:parameters ruleUpdate type InstanceRuleUpdateRequest struct { - ID string `form:"id"` - Text string `form:"text"` + // The id of the rule to update. + // required: true + // in: path + ID string `form:"id" json:"id"` + // Text body for the updated instance rule, plaintext. + // required: true + // in: formData + Text string `form:"text" json:"text"` } -- cgit v1.2.3