Files
openproject/docs/api/apiv3/components/examples/version_simple_response.yml
T
Eric Schubert 10d472052d [#71358] improve API specification for versions
- split into read and write models
- add custom field pattern properties
- improved description for endpoints
- add extracted examples
2026-02-11 16:35:03 +01:00

42 lines
1.1 KiB
YAML

# Example: Version simple response
---
description: Simple response showing a single version
value:
_type: Version
id: 3
name: v0.9.1-alpha
description:
format: plain
raw: "First draft of the energy weapon ... (behold, Alderaan *evil_laughter*)"
html: "<p>First draft of the energy weapon ... (behold, Alderaan *evil_laughter*)</p>"
startDate: "2026-02-02"
endDate: "2026-02-09"
status: closed
sharing: none
createdAt: "2026-02-06T09:30:49.157Z"
updatedAt: "2026-02-10T09:53:21.620Z"
customField14: true
_links:
self:
href: "/api/v3/versions/1"
title: "v0.1.0-alpha"
schema:
href: "/api/v3/versions/schema"
update:
href: "/api/v3/versions/1/form"
method: "post"
updateImmediately:
href: "/api/v3/versions/1"
method: "patch"
delete:
href: "/api/v3/versions/1"
method: "delete"
availableInProjects:
href: "/api/v3/versions/1/workspaces"
definingProject:
href: "/api/v3/projects/10"
title: "Death Star"
customField23:
href: "/api/v3/users/18"
title: "Mara Jade"