Files
medusa-store/packages/medusa/src/api/routes/admin/publishable-api-keys/update-publishable-api-key.ts
T
2022-12-26 18:09:22 +02:00

104 lines
3.1 KiB
TypeScript

import { Request, Response } from "express"
import { IsOptional, IsString } from "class-validator"
import { EntityManager } from "typeorm"
import PublishableApiKeyService from "../../../../services/publishable-api-key"
/**
* @oas [post] /publishable-api-key/{id}
* operationId: "PostPublishableApiKysPublishableApiKey"
* summary: "Update PublishableApiKey"
* description: "Updates a PublishableApiKey."
* x-authenticated: true
* parameters:
* - (path) id=* {string} The ID of the PublishableApiKey.
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostPublishableApiKeysPublishableApiKeyReq"
* x-codeSamples:
* - lang: JavaScript
* label: JS Client
* source: |
* import Medusa from "@medusajs/medusa-js"
* const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
* // must be previously logged in or use api token
* medusa.admin.publishableApiKey.update(publishable_key_id, {
* title: "new title"
* })
* .then(({ publishable_api_key }) => {
* console.log(publishable_api_key.id)
* })
* - lang: Shell
* label: cURL
* source: |
* curl --location --request POST 'https://medusa-url.com/admin/publishable-api-key/{id}' \
* --header 'Authorization: Bearer {api_token}' \
* --header 'Content-Type: application/json' \
* --data-raw '{
* "title": "updated title"
* }'
* security:
* - api_token: []
* - cookie_auth: []
* tags:
* - PublishableApiKey
* responses:
* 200:
* description: OK
* content:
* application/json:
* schema:
* type: object
* properties:
* publishable_api_key:
* $ref: "#/components/schemas/PublishableApiKey"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*/
export default async (req: Request, res: Response) => {
const { id } = req.params
const { validatedBody } = req as {
validatedBody: AdminPostPublishableApiKeysPublishableApiKeyReq
}
const publishableApiKeysService: PublishableApiKeyService = req.scope.resolve(
"publishableApiKeyService"
)
const manager: EntityManager = req.scope.resolve("manager")
const updatedKey = await manager.transaction(async (transactionManager) => {
return await publishableApiKeysService
.withTransaction(transactionManager)
.update(id, validatedBody)
})
res.status(200).json({ publishable_api_key: updatedKey })
}
/**
* @schema AdminPostPublishableApiKeysPublishableApiKeyReq
* type: object
* properties:
* title:
* description: A title to update for the key.
* type: string
*/
export class AdminPostPublishableApiKeysPublishableApiKeyReq {
@IsString()
@IsOptional()
title?: string
}