api/v1/swagger/swagger.yaml

   1 ---
   2 swagger: 2.0
   3 basePath: /api/v1
   4 paths:
   5   $ref: paths.json
   6 definitions:
   7   $ref: definitions.json
   8 parameters:
   9   $ref: parameters.json
  10 x-primitives:
  11   $ref: x-primitives.json
  12 info:
  13   title: Koha REST API
  14   version: "1"
  15   license:
  16     name: GPL v3,
  17     url: http://www.gnu.org/licenses/gpl.txt
  18   contact:
  19     name: Koha Development Team
  20     url: https://koha-community.org/
  21   description: |
  22     ## Introduction
  23
  24     This API is documented in **OpenAPI format**.
  25
  26     ## Special headers
  27
  28     ### x-koha-library
  29
  30     This optional header should be passed to give your api request a library
  31     context; If it is not included in the request, then the request context
  32     will default to using your api comsumer's assigned home library.
  33 tags:
  34   - name: "biblios"
  35     x-displayName: Biblios
  36     description: |
  37       Manage bibliographic records
  38   - name: "cashups"
  39     x-displayName: Cashups
  40     description: |
  41       Manage cash register cashups
  42   - name: "checkouts"
  43     x-displayName: Checkouts
  44     description: |
  45       Manage checkouts
  46   - name: "circulation_rules"
  47     x-displayName: Circulation rules
  48     description: |
  49       Manage circulation rules
  50   - name: "cities"
  51     x-displayName: Cities
  52     description: |
  53       Manage cities
  54   - name: "clubs"
  55     x-displayName: Clubs
  56     description: |
  57       Manage patron clubs
  58   - name: "funds"
  59     x-displayName: Funds
  60     description: |
  61       Manage funds for the acquisitions module
  62   - name: "holds"
  63     x-displayName: Holds
  64     description: |
  65       Manage holds
  66   - name: "illbackends"
  67     x-displayName: ILL backends
  68     description: |
  69       Manage ILL module backends
  70   - name: "illrequests"
  71     x-displayName: ILL requests
  72     description: |
  73       Manage ILL requests
  74   - name: "items"
  75     x-displayName: Items
  76     description: |
  77       Manage items
  78   - name: "library"
  79     x-displayName: Libraries
  80     description: |
  81       Manage libraries
  82   - name: "macros"
  83     x-displayName: Macros
  84     description: |
  85       Manage macros
  86   - name: "orders"
  87     x-displayName: Orders
  88     description: |
  89       Manage acquisition orders
  90   - name: "oauth"
  91     x-displayName: "OAuth"
  92     description: |
  93       Handle OAuth flows
  94   - name: "patrons"
  95     x-displayName: Patrons
  96     description: |
  97       Manage patrons
  98   - name: "quotes"
  99     x-displayName: Quotes
 100     description: |
 101       Manage quotes
 102   - name: "return_claims"
 103     x-displayName: Return claims
 104     description: |
 105       Manage return claims
 106   - name: "rotas"
 107     x-displayName: Rotas
 108     description: |
 109       Manage rotas
 110   - name: "smtp_servers"
 111     x-displayName: SMTP servers
 112     description: |
 113       Manage SMTP servers configurations
 114   - name: "transfer"
 115     x-displayName: Transfer limits
 116     description: |
 117       Manage transfer limits
 118   - name: "vendors"
 119     x-displayName: "Vendors"
 120     description: |
 121       Manage vendors for the acquisitions module
 122   - name: "batch_import_profiles"
 123     x-displayName: Batch import profiles
 124     description: |
 125       Manage batch import profiles