[0ce187]: / Allura / docs / api-rest / resourceTypes.yaml  Maximize  Restore  History

Download this file

108 lines (104 with data), 3.0 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
- base:
get?:
responses: &standardResponses # yaml syntax to alias properties
200:
description: OK
put?:
responses: *standardResponses
patch?:
responses: *standardResponses
post?:
responses:
201:
description: Created
delete?:
responses: *standardResponses
- collection:
type: base
get:
is: [ pageable, bearerAuth ]
- generic:
# this is really just a shorthand for us when we have a schema & example
# so we couldn't come up with a good name and picked something generic :)
type: base
get:
is: [ bearerAuth ]
responses:
200:
body:
application/json:
schema: <<schema>>
example: <<example>>
post?:
put?:
body:
application/json:
schema: <<schema>>
responses:
200:
body:
application/json:
schema: <<schema>>
patch?:
body:
application/json:
schema: <<schema>>
responses:
200:
body:
application/json:
schema: <<schema>>
delete?:
- searchableCollection:
get:
is: [ bearerAuth ]
queryParameters:
<<queryParamName>>:
description: Return <<resourcePathName>> that have their <<queryParamName>> matching the given value
example: <<queryParamExample>>
required: true
responses:
200:
body:
application/json:
schema: <<schema>>
example: <<example>>
- typedCollection:
type: collection
get:
responses:
200:
body:
application/json:
schema: <<schema>>
example: <<example>>
- permission:
description: |
Checks if a given user has permissions.
get:
is: [permissionTestable, bearerAuth]
- project:
type: base
get:
responses:
200:
body:
application/json:
schema: <<schema>>
example: <<example>>