Created
October 4, 2023 21:20
-
-
Save DavidBiesack/daf37ce9d6e56a60c2d8ed8215bd67b8 to your computer and use it in GitHub Desktop.
OpenAPI operation to delete a Universe from the Chain Links applications
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openapi: '3.1.0' | |
info: | |
title: deleteUniverse operation | |
description: Part of the Chain Links API. | |
contact: | |
name: David Biesack | |
url: https://gist.github.com/DavidBiesack | |
version: 0.0.0 | |
tags: | |
- name: Universes | |
description: A universe in which Chains (fan fiction stories) exist | |
servers: | |
- url: https://api.chainlinks.example.com | |
paths: | |
/universes/{universeId}: | |
parameters: | |
- $ref: '#/components/parameters/universeIdPathParam' | |
delete: | |
summary: Delete a Universe instance. | |
description: >- | |
Delete a Chain Link Universe instance. | |
operationId: deleteUniverse | |
tags: | |
- Universes | |
responses: | |
'204': | |
$ref: 'common.yaml#/components/responses/204' | |
'404': | |
$ref: 'common.yaml#/components/responses/404' | |
'409': | |
description: >- | |
Conflict. The universe may not be deleted because it is in use. | |
content: | |
application/json: | |
schema: | |
$ref: 'common.yaml#/components/schemas/apiProblem' | |
components: | |
parameters: | |
universeIdPathParam: | |
name: universeId | |
description: The unique `id` of an existing Universe instance. | |
in: path | |
required: true | |
schema: | |
$ref: 'common.yaml#/components/schemas/resourceId' |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment