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

78 lines
2.3 KiB
TypeScript

import { EntityManager } from "typeorm"
import PublishableApiKeyService from "../../../../services/publishable-api-key"
/**
* @oas [delete] /publishable-api-keys/{id}
* operationId: "DeletePublishableApiKeysPublishableApiKey"
* summary: "Delete PublishableApiKey"
* description: "Deletes a PublishableApiKeys"
* x-authenticated: true
* parameters:
* - (path) id=* {string} The ID of the PublishableApiKeys to delete.
* 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.delete(key_id)
* .then(({ id, object, deleted }) => {
* console.log(id)
* })
* - lang: Shell
* label: cURL
* source: |
* curl --location --request DELETE 'https://medusa-url.com/admin/publishable-api-key/{id}' \
* --header 'Authorization: Bearer {api_token}'
* security:
* - api_token: []
* - cookie_auth: []
* tags:
* - PublishableApiKey
* responses:
* 200:
* description: OK
* content:
* application/json:
* schema:
* type: object
* properties:
* id:
* type: string
* description: The ID of the deleted PublishableApiKey.
* object:
* type: string
* description: The type of the object that was deleted.
* format: publishable_api_key
* deleted:
* type: boolean
* description: Whether the PublishableApiKeys was deleted.
* default: true
* "400":
* $ref: "#/components/responses/400_error"
*/
export default async (req, res) => {
const { id } = req.params
const publishableApiKeyService: PublishableApiKeyService = req.scope.resolve(
"publishableApiKeyService"
)
const manager: EntityManager = req.scope.resolve("manager")
await manager.transaction(async (transactionManager) => {
await publishableApiKeyService
.withTransaction(transactionManager)
.delete(id)
})
res.status(200).send({
id,
object: "publishable_api_key",
deleted: true,
})
}