57 lines
4.3 KiB
YAML
57 lines
4.3 KiB
YAML
nelmio_api_doc:
|
|
models:
|
|
use_jms: true
|
|
names:
|
|
- { alias: CustomerEditForm, type: App\Form\API\CustomerApiEditForm, groups: [Default, Entity, Customer] }
|
|
- { alias: CustomerEntity, type: App\Entity\Customer, groups: [Default, Entity, Customer] }
|
|
- { alias: CustomerMetaField, type: App\Entity\CustomerMeta, groups: [Default, Customer] }
|
|
- { alias: CustomerCollection, type: App\Entity\Customer, groups: [Default, Collection, Customer] }
|
|
- { alias: ProjectEditForm, type: App\Form\API\ProjectApiEditForm, groups: [Default, Entity, Project] }
|
|
- { alias: ProjectEntity, type: App\Entity\Project, groups: [Default, Entity, Project] }
|
|
- { alias: ProjectMetaField, type: App\Entity\ProjectMeta, groups: [Default, Project] }
|
|
- { alias: ProjectCollection, type: App\Entity\Project, groups: [Default, Collection, Project] }
|
|
- { alias: ActivityEditForm, type: App\Form\API\ActivityApiEditForm, groups: [Default, Entity, Activity] }
|
|
- { alias: ActivityEntity, type: App\Entity\Activity, groups: [Default, Entity, Activity] }
|
|
- { alias: ActivityMetaField, type: App\Entity\ActivityMeta, groups: [Default, Activity] }
|
|
- { alias: ActivityCollection, type: App\Entity\Activity, groups: [Default, Collection, Activity] }
|
|
- { alias: TagEditForm, type: App\Form\API\TagApiEditForm, groups: [Default, Entity, Tag] }
|
|
- { alias: TagEntity, type: App\Entity\Tag, groups: [Default, Entity, Tag] }
|
|
- { alias: TimesheetEditForm, type: App\Form\API\TimesheetApiEditForm, groups: [Default, Entity, Timesheet] }
|
|
- { alias: TimesheetEntity, type: App\Entity\Timesheet, groups: [Default, Entity, Timesheet] }
|
|
- { alias: TimesheetMeta, type: App\Entity\TimesheetMeta, groups: [Default, Timesheet] }
|
|
- { alias: TimesheetCollection, type: App\Entity\Timesheet, groups: [Default, Collection, Timesheet] }
|
|
- { alias: TimesheetSubCollection, type: App\Entity\Timesheet, groups: [Default, Subresource, Timesheet] }
|
|
- { alias: UserEntity, type: App\Entity\User, groups: [Default, Entity, User] }
|
|
- { alias: UserCollection, type: App\Entity\User, groups: [Default, Collection, User] }
|
|
- { alias: TeamEntity, type: App\Entity\Team, groups: [Default, Entity, Team] }
|
|
- { alias: TeamCollection, type: App\Entity\Team, groups: [Default, Collection, Team] }
|
|
- { alias: I18nConfig, type: App\API\Model\I18n, groups: [Default] }
|
|
areas:
|
|
path_patterns:
|
|
- ^/api(?!/doc)
|
|
documentation:
|
|
#host: '{{hostname}}'
|
|
host: '%router.request_context.host%'
|
|
basePath: '%router.request_context.base_url%'
|
|
schemes: ['%router.request_context.scheme%']
|
|
info:
|
|
title: Kimai 2 - API Docs
|
|
description: |
|
|
REST API for the Kimai 2 time-tracking software. Read more about its usage in the [API documentation](https://www.kimai.org/documentation/rest-api.html) and then download a [Swagger file](doc.json) for import e.g. in Postman.
|
|
Be aware: it is not yet considered stable and BC breaks might happen, but we try to avoid them.
|
|
version: 0.3
|
|
securityDefinitions:
|
|
apiUser:
|
|
type: apiKey
|
|
description: 'Value: {Username}'
|
|
name: X-AUTH-USER
|
|
in: header
|
|
apiToken:
|
|
type: apiKey
|
|
description: 'Value: {API Token}'
|
|
name: X-AUTH-TOKEN
|
|
in: header
|
|
security:
|
|
- X-AUTH-USER: []
|
|
- X-AUTH-TOKEN: []
|