View | Details | Raw Unified | Return to bug 33105
Collapse All | Expand All

(-)a/api/v1/swagger/definitions/vendor_issue.yaml (+37 lines)
Line 0 Link Here
1
---
2
type: object
3
properties:
4
  issue_id:
5
    type: integer
6
    description: internally assigned vendor identifier
7
    readOnly: true
8
  vendor_id:
9
    type:
10
      - string
11
    description: Vendor id
12
  type:
13
    type:
14
      - string
15
      - "null"
16
    description: Type of the issue
17
  started_on:
18
    type:
19
      - string
20
      - "null"
21
    description: Start date
22
  ended_on:
23
    type:
24
      - string
25
      - "null"
26
    description: End date
27
  notes:
28
    type:
29
      - string
30
      - "null"
31
    description: Notes
32
  _strings:
33
    type:
34
      - object
35
      - "null"
36
    description: A list of stringified coded values
37
additionalProperties: false
(-)a/api/v1/swagger/paths/acquisitions_vendor_issues.yaml (+92 lines)
Line 0 Link Here
1
---
2
"/acquisitions/vendors/{vendor_id}/issues":
3
  get:
4
    x-mojo-to: Acquisitions::Vendor::Issues#list
5
    operationId: listVendorIssues
6
    tags:
7
      - vendors
8
    summary: List vendor issues
9
    produces:
10
      - application/json
11
    parameters:
12
      - $ref: "../swagger.yaml#/parameters/vendor_id_pp"
13
      - description: Case insensitive search on issue's id
14
        in: query
15
        name: issue_id
16
        required: false
17
        type: integer
18
      - description: Case insensitive search on vendor's id
19
        in: query
20
        name: vendor_id
21
        required: false
22
        type: integer
23
      - name: type
24
        in: query
25
        description: Case insensitive search on issue type
26
        required: false
27
        type: string
28
      - description: Case insensitive search on issue start date
29
        in: query
30
        name: started_on
31
        required: false
32
        type: string
33
      - description: Case insensitive search on issue end date
34
        in: query
35
        name: ended_on
36
        required: false
37
        type: string
38
      - name: notes
39
        in: query
40
        description: Case insensitive search on issue's notes
41
        required: false
42
        type: string
43
      - name: x-koha-embed
44
        in: header
45
        required: false
46
        description: Embed list sent as a request header
47
        type: array
48
        items:
49
          type: string
50
          enum:
51
            - +strings
52
        collectionFormat: csv
53
      - $ref: "../swagger.yaml#/parameters/match"
54
      - $ref: "../swagger.yaml#/parameters/order_by"
55
      - $ref: "../swagger.yaml#/parameters/page"
56
      - $ref: "../swagger.yaml#/parameters/per_page"
57
      - $ref: "../swagger.yaml#/parameters/q_param"
58
      - $ref: "../swagger.yaml#/parameters/q_body"
59
      - $ref: "../swagger.yaml#/parameters/q_header"
60
      - $ref: "../swagger.yaml#/parameters/request_id_header"
61
    responses:
62
      "200":
63
        description: A list of issues
64
        schema:
65
          type: array
66
          items:
67
            $ref: "../swagger.yaml#/definitions/vendor_issue"
68
      "401":
69
        description: Authentication required
70
        schema:
71
          $ref: "../swagger.yaml#/definitions/error"
72
      403:
73
        description: Access forbidden
74
        schema:
75
          $ref: "../swagger.yaml#/definitions/error"
76
      "404":
77
        description: Resource not found
78
        schema:
79
          $ref: "../swagger.yaml#/definitions/error"
80
      500:
81
        description: |-
82
          Internal server error. Possible `error_code` attribute values:
83
          * `internal_server_error`
84
        schema:
85
          $ref: "../swagger.yaml#/definitions/error"
86
      503:
87
        description: Under maintenance
88
        schema:
89
          $ref: "../swagger.yaml#/definitions/error"
90
    x-koha-authorization:
91
      permissions:
92
        acquisition: issues_manage
(-)a/api/v1/swagger/swagger.yaml (-1 / +4 lines)
Lines 100-105 definitions: Link Here
100
    $ref: ./definitions/transfer_limit.yaml
100
    $ref: ./definitions/transfer_limit.yaml
101
  vendor:
101
  vendor:
102
    $ref: ./definitions/vendor.yaml
102
    $ref: ./definitions/vendor.yaml
103
  vendor_issue:
104
    $ref: ./definitions/vendor_issue.yaml
103
paths:
105
paths:
104
  /acquisitions/baskets/managers:
106
  /acquisitions/baskets/managers:
105
    $ref: paths/acquisitions_baskets.yaml#/~1acquisitions~1baskets~1managers
107
    $ref: paths/acquisitions_baskets.yaml#/~1acquisitions~1baskets~1managers
Lines 117-122 paths: Link Here
117
    $ref: ./paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors
119
    $ref: ./paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors
118
  "/acquisitions/vendors/{vendor_id}":
120
  "/acquisitions/vendors/{vendor_id}":
119
    $ref: "./paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors~1{vendor_id}"
121
    $ref: "./paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors~1{vendor_id}"
122
  "/acquisitions/vendors/{vendor_id}/issues":
123
    $ref: "./paths/acquisitions_vendor_issues.yaml#/~1acquisitions~1vendors~1{vendor_id}~1issues"
120
  /advanced_editor/macros:
124
  /advanced_editor/macros:
121
    $ref: ./paths/advancededitormacros.yaml#/~1advanced_editor~1macros
125
    $ref: ./paths/advancededitormacros.yaml#/~1advanced_editor~1macros
122
  /advanced_editor/macros/shared:
126
  /advanced_editor/macros/shared:
123
- 

Return to bug 33105