From 79a970cc3f5b1c336fd88cbbbef8d98d0e332fa4 Mon Sep 17 00:00:00 2001 From: blockscout-bot Date: Mon, 20 Jan 2025 13:31:40 +0000 Subject: [PATCH] [BOT] [CREATE-SWAGGER] [SKIP-GH-PAGES] create swagger for "merits-admin" of version main --- services/merits-admin/main/swagger.yaml | 310 +++++++++++++++++++++++- 1 file changed, 308 insertions(+), 2 deletions(-) diff --git a/services/merits-admin/main/swagger.yaml b/services/merits-admin/main/swagger.yaml index a3458ed..261e694 100644 --- a/services/merits-admin/main/swagger.yaml +++ b/services/merits-admin/main/swagger.yaml @@ -36,7 +36,7 @@ paths: $ref: '#/definitions/v1AdminDistributeRequest' tags: - PointsAdminService - /admin/api/v1/network/{chain_id}: + /admin/api/v1/networks/{chain_id}: post: operationId: PointsAdminService_AdminAddNetwork responses: @@ -83,7 +83,161 @@ paths: $ref: '#/definitions/PointsAdminServiceAdminUpdateNetworkBody' tags: - PointsAdminService - /admin/api/v1/user/{address_or_code}: + /admin/api/v1/offers/{offer_id}: + post: + operationId: PointsAdminService_AdminAddOffer + responses: + "200": + description: A successful response. + schema: + $ref: '#/definitions/v1AdminAddOfferResponse' + default: + description: An unexpected error response. + schema: + $ref: '#/definitions/rpcStatus' + parameters: + - name: offer_id + in: path + required: true + type: string + - name: body + in: body + required: true + schema: + $ref: '#/definitions/PointsAdminServiceAdminAddOfferBody' + tags: + - PointsAdminService + patch: + operationId: PointsAdminService_AdminUpdateOffer + responses: + "200": + description: A successful response. + schema: + $ref: '#/definitions/v1AdminUpdateOfferResponse' + default: + description: An unexpected error response. + schema: + $ref: '#/definitions/rpcStatus' + parameters: + - name: offer_id + in: path + required: true + type: string + - name: body + in: body + required: true + schema: + $ref: '#/definitions/PointsAdminServiceAdminUpdateOfferBody' + tags: + - PointsAdminService + /admin/api/v1/offers/{offer_id}/redemptions: + get: + operationId: PointsAdminService_AdminGetOfferRedemptions + responses: + "200": + description: A successful response. + schema: + $ref: '#/definitions/v1AdminGetOfferRedemptionsResponse' + default: + description: An unexpected error response. + schema: + $ref: '#/definitions/rpcStatus' + parameters: + - name: offer_id + in: path + required: true + type: string + - name: page_size + in: query + required: false + type: integer + format: int64 + - name: page_token + in: query + required: false + type: string + tags: + - PointsAdminService + /admin/api/v1/offers/{offer_id}/secrets: + get: + operationId: PointsAdminService_AdminGetOfferSecrets + responses: + "200": + description: A successful response. + schema: + $ref: '#/definitions/v1AdminGetOfferSecretsResponse' + default: + description: An unexpected error response. + schema: + $ref: '#/definitions/rpcStatus' + parameters: + - name: offer_id + in: path + required: true + type: string + - name: is_redeemed + in: query + required: false + type: boolean + - name: page_size + in: query + required: false + type: integer + format: int64 + - name: page_token + in: query + required: false + type: string + tags: + - PointsAdminService + post: + operationId: PointsAdminService_AdminAddOfferSecrets + responses: + "200": + description: A successful response. + schema: + $ref: '#/definitions/v1AdminAddOfferSecretsResponse' + default: + description: An unexpected error response. + schema: + $ref: '#/definitions/rpcStatus' + parameters: + - name: offer_id + in: path + required: true + type: string + - name: body + in: body + required: true + schema: + $ref: '#/definitions/PointsAdminServiceAdminAddOfferSecretsBody' + tags: + - PointsAdminService + /admin/api/v1/offers/{offer_id}/secrets/{secret_id}: + delete: + operationId: PointsAdminService_AdminDeleteOfferSecret + responses: + "200": + description: A successful response. + schema: + $ref: '#/definitions/v1AdminDeleteOfferSecretResponse' + default: + description: An unexpected error response. + schema: + $ref: '#/definitions/rpcStatus' + parameters: + - name: offer_id + in: path + required: true + type: string + - name: secret_id + in: path + required: true + type: integer + format: int32 + tags: + - PointsAdminService + /admin/api/v1/users/{address_or_code}: get: operationId: PointsAdminService_AdminUserInfo responses: @@ -102,6 +256,30 @@ paths: type: string tags: - PointsAdminService + /admin/api/v1/users/{address}/code: + post: + operationId: PointsAdminService_AdminUpdateReferralCode + responses: + "200": + description: A successful response. + schema: + $ref: '#/definitions/v1AdminUpdateReferralCodeResponse' + default: + description: An unexpected error response. + schema: + $ref: '#/definitions/rpcStatus' + parameters: + - name: address + in: path + required: true + type: string + - name: body + in: body + required: true + schema: + $ref: '#/definitions/PointsAdminServiceAdminUpdateReferralCodeBody' + tags: + - PointsAdminService definitions: PointsAdminServiceAdminAddNetworkBody: type: object @@ -112,6 +290,36 @@ definitions: type: string active: type: boolean + PointsAdminServiceAdminAddOfferBody: + type: object + properties: + details: + type: object + price: + type: string + weight: + type: integer + format: int32 + valid_since: + type: string + valid_until: + type: string + redemptions_limit: + type: integer + format: int32 + is_hidden: + type: boolean + is_unique_per_address: + type: boolean + is_auto_filled: + type: boolean + PointsAdminServiceAdminAddOfferSecretsBody: + type: object + properties: + details: + type: array + items: + type: string PointsAdminServiceAdminUpdateNetworkBody: type: object properties: @@ -121,6 +329,36 @@ definitions: type: string active: type: boolean + PointsAdminServiceAdminUpdateOfferBody: + type: object + properties: + details: + type: object + price: + type: string + weight: + type: integer + format: int32 + valid_since: + type: string + valid_until: + type: string + redemptions_limit: + type: integer + format: int32 + is_hidden: + type: boolean + is_unique_per_address: + type: boolean + is_auto_filled: + type: boolean + PointsAdminServiceAdminUpdateReferralCodeBody: + type: object + properties: + old_code: + type: string + new_code: + type: string protobufAny: type: object properties: @@ -154,6 +392,12 @@ definitions: $ref: '#/definitions/protobufAny' v1AdminAddNetworkResponse: type: object + v1AdminAddOfferResponse: + type: object + v1AdminAddOfferSecretsResponse: + type: object + v1AdminDeleteOfferSecretResponse: + type: object v1AdminDistributeRequest: type: object properties: @@ -179,8 +423,32 @@ definitions: accounts_created: type: string format: uint64 + v1AdminGetOfferRedemptionsResponse: + type: object + properties: + items: + type: array + items: + type: object + $ref: '#/definitions/v1OfferRedemption' + next_page_params: + $ref: '#/definitions/v1Pagination' + v1AdminGetOfferSecretsResponse: + type: object + properties: + items: + type: array + items: + type: object + $ref: '#/definitions/v1OfferSecret' + next_page_params: + $ref: '#/definitions/v1Pagination' v1AdminUpdateNetworkResponse: type: object + v1AdminUpdateOfferResponse: + type: object + v1AdminUpdateReferralCodeResponse: + type: object v1AdminUserInfoResponse: type: object properties: @@ -221,6 +489,44 @@ definitions: type: string pending_referral_rewards: type: string + v1OfferRedemption: + type: object + properties: + offer_id: + type: string + address: + type: string + redemption: + type: string + format: uint64 + price: + type: string + note: + type: string + redeemed_at: + type: string + secret: + type: string + v1OfferSecret: + type: object + properties: + secret_id: + type: integer + format: int32 + offer_id: + type: string + details: + type: string + is_redeemed: + type: boolean + v1Pagination: + type: object + properties: + page_token: + type: string + page_size: + type: integer + format: int64 v1UserLog: type: object properties: