OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
openproject/docs/api/apiv3/paths/example_schema.yml

71 lines
2.3 KiB

# /api/v3/example/schema
---
get:
responses:
'200':
content:
application/hal+json:
examples:
response:
value:
_dependencies: []
_links:
self:
href: "/api/v3/example/schema"
_type: Schema
lockVersion:
name: Resource Version
type: Integer
writable: false
status:
_embedded:
allowedValues:
- _links:
self:
href: "/api/v3/statuses/1"
_type: Status
createdAt: '2014-05-21T08:51:20Z'
defaultDoneRatio: 0
id: 1
isClosed: false
isDefault: true
name: New
position: 1
updatedAt: '2014-05-21T09:12:00Z'
- _links:
self:
href: "/api/v3/statuses/2"
_type: Status
createdAt: '2014-05-21T08:51:20Z'
defaultDoneRatio: 100
id: 2
isClosed: true
isDefault: false
name: Closed
position: 2
updatedAt: '2014-05-21T09:12:00Z'
_links:
allowedValues:
- href: "/api/v3/statuses/1"
title: New
- href: "/api/v3/statuses/2"
title: Closed
location: _links
name: Status
type: Status
subject:
maxLength: 255
minLength: 1
name: Subject
type: String
schema:
"$ref": "../components/schemas/example_schema_model.yml"
description: OK
headers: {}
tags:
- Schemas
description: This is an example of how a schema might look like. Note that this
endpoint does not exist in the actual implementation.
operationId: view_the_schema
summary: view the schema