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

(-)a/api/v1/swagger/paths.json (-3 / +9 lines)
Lines 92-97 Link Here
92 
  "/libraries": {
 92 
  "/libraries": {
93 
    "$ref": "paths/libraries.json#/~1libraries"
 93 
    "$ref": "paths/libraries.json#/~1libraries"
94 
  },
 94 
  },
95 
  "/libraries/{library_id}": {
96 
    "$ref": "paths/libraries.json#/~1libraries~1{library_id}"
97 
  },
95 
  "/transfer_limits": {
 98 
  "/transfer_limits": {
96 
    "$ref": "paths/transfer_limits.yaml#/~1transfer_limits"
 99 
    "$ref": "paths/transfer_limits.yaml#/~1transfer_limits"
97 
  },
 100 
  },
Lines 101-109 Link Here
101 
  "/transfer_limits/batch": {
 104 
  "/transfer_limits/batch": {
102 
    "$ref": "paths/transfer_limits.yaml#/~1transfer_limits~1batch"
 105 
    "$ref": "paths/transfer_limits.yaml#/~1transfer_limits~1batch"
103 
  },
 106 
  },
104 
  "/libraries/{library_id}": {
105 
    "$ref": "paths/libraries.json#/~1libraries~1{library_id}"
106 
  },
107 
  "/checkouts/{checkout_id}/allows_renewal": {
 107 
  "/checkouts/{checkout_id}/allows_renewal": {
108 
    "$ref": "paths/checkouts.json#/~1checkouts~1{checkout_id}~1allows_renewal"
 108 
    "$ref": "paths/checkouts.json#/~1checkouts~1{checkout_id}~1allows_renewal"
109 
  },
 109 
  },
Lines 164-169 Link Here
164 
  "/public/biblios/{biblio_id}": {
 164 
  "/public/biblios/{biblio_id}": {
165 
    "$ref": "paths/biblios.json#/~1public~1biblios~1{biblio_id}"
 165 
    "$ref": "paths/biblios.json#/~1public~1biblios~1{biblio_id}"
166 
  },
 166 
  },
167 
  "/public/libraries": {
168 
    "$ref": "paths/libraries.json#/~1public~1libraries"
169 
  },
170 
  "/public/libraries/{library_id}": {
171 
    "$ref": "paths/libraries.json#/~1public~1libraries~1{library_id}"
172 
  },
167 
  "/public/patrons/{patron_id}/article_requests/{article_request_id}": {
 173 
  "/public/patrons/{patron_id}/article_requests/{article_request_id}": {
168 
    "$ref": "paths/article_requests.yaml#/~1public~1patrons~1{patron_id}~1article_requests~1{article_request_id}"
 174 
    "$ref": "paths/article_requests.yaml#/~1public~1patrons~1{patron_id}~1article_requests~1{article_request_id}"
169 
  },
 175 
  },
(-)a/api/v1/swagger/paths/libraries.json (-1 / +249 lines)
Lines 431-435 Link Here
431 
        }
 431 
        }
432 
      }
 432 
      }
433 
    }
 433 
    }
434 
  },
435 
  "/public/libraries": {
436 
    "get": {
437 
      "x-mojo-to": "Libraries#list",
438 
      "operationId": "listLibrariesPublic",
439 
      "tags": [
440 
        "library"
441 
      ],
442 
      "summary": "List libraries",
443 
      "parameters": [
444 
        {
445 
          "name": "name",
446 
          "in": "query",
447 
          "description": "Case insensitive 'starts-with' search on name",
448 
          "required": false,
449 
          "type": "string"
450 
        },
451 
        {
452 
          "name": "address1",
453 
          "in": "query",
454 
          "description": "Case insensitive 'starts-with' search on address1",
455 
          "required": false,
456 
          "type": "string"
457 
        },
458 
        {
459 
          "name": "address2",
460 
          "in": "query",
461 
          "description": "Case insensitive 'starts-with' search on address2",
462 
          "required": false,
463 
          "type": "string"
464 
        },
465 
        {
466 
          "name": "address3",
467 
          "in": "query",
468 
          "description": "Case insensitive 'starts-with' search on address3",
469 
          "required": false,
470 
          "type": "string"
471 
        },
472 
        {
473 
          "name": "postal_code",
474 
          "in": "query",
475 
          "description": "Case insensitive 'starts-with' search on postal code",
476 
          "required": false,
477 
          "type": "string"
478 
        },
479 
        {
480 
          "name": "city",
481 
          "in": "query",
482 
          "description": "Case insensitive 'starts-with' search on city",
483 
          "required": false,
484 
          "type": "string"
485 
        },
486 
        {
487 
          "name": "state",
488 
          "in": "query",
489 
          "description": "Case insensitive 'starts-with' search on state",
490 
          "required": false,
491 
          "type": "string"
492 
        },
493 
        {
494 
          "name": "country",
495 
          "in": "query",
496 
          "description": "Case insensitive 'starts_with' search on country",
497 
          "required": false,
498 
          "type": "string"
499 
        },
500 
        {
501 
          "name": "phone",
502 
          "in": "query",
503 
          "description": "Case insensitive 'starts_with' search on phone number",
504 
          "required": false,
505 
          "type": "string"
506 
        },
507 
        {
508 
          "name": "fax",
509 
          "in": "query",
510 
          "description": "Case insensitive 'starts_with' search on fax number",
511 
          "required": false,
512 
          "type": "string"
513 
        },
514 
        {
515 
          "name": "email",
516 
          "in": "query",
517 
          "description": "Case insensitive 'starts_with' search on email address",
518 
          "required": false,
519 
          "type": "string"
520 
        },
521 
        {
522 
          "name": "reply_to_email",
523 
          "in": "query",
524 
          "description": "Case insensitive 'starts_with' search on Reply-To email address",
525 
          "required": false,
526 
          "type": "string"
527 
        },
528 
        {
529 
          "name": "return_path_email",
530 
          "in": "query",
531 
          "description": "Case insensitive 'starts_with' search on Return-Path email address",
532 
          "required": false,
533 
          "type": "string"
534 
        },
535 
        {
536 
          "name": "url",
537 
          "in": "query",
538 
          "description": "Case insensitive 'starts_with' search on website URL",
539 
          "required": false,
540 
          "type": "string"
541 
        },
542 
        {
543 
          "name": "ip",
544 
          "in": "query",
545 
          "description": "Case insensitive 'starts_with' search on IP address",
546 
          "required": false,
547 
          "type": "string"
548 
        },
549 
        {
550 
          "name": "notes",
551 
          "in": "query",
552 
          "description": "Case insensitive 'starts_with' search on notes",
553 
          "required": false,
554 
          "type": "string"
555 
        },
556 
        {
557 
          "name": "opac_info",
558 
          "in": "query",
559 
          "description": "Case insensitive 'starts-with' search on OPAC info",
560 
          "required": false,
561 
          "type": "string"
562 
        },
563 
        {
564 
          "$ref": "../parameters.json#/match"
565 
        },
566 
        {
567 
          "$ref": "../parameters.json#/order_by"
568 
        },
569 
        {
570 
          "$ref": "../parameters.json#/page"
571 
        },
572 
        {
573 
          "$ref": "../parameters.json#/per_page"
574 
        },
575 
        {
576 
          "$ref": "../parameters.json#/q_param"
577 
        },
578 
        {
579 
          "$ref": "../parameters.json#/q_body"
580 
        },
581 
        {
582 
          "$ref": "../parameters.json#/q_header"
583 
        }
584 
      ],
585 
      "produces": [
586 
        "application/json"
587 
      ],
588 
      "responses": {
589 
        "200": {
590 
          "description": "A list of libraries",
591 
          "schema": {
592 
            "type": "array",
593 
            "items": {
594 
              "$ref": "../definitions.json#/library"
595 
            }
596 
          }
597 
        },
598 
        "500": {
599 
          "description": "Internal error",
600 
          "schema": {
601 
            "$ref": "../definitions.json#/error"
602 
          }
603 
        },
604 
        "503": {
605 
          "description": "Under maintenance",
606 
          "schema": {
607 
            "$ref": "../definitions.json#/error"
608 
          }
609 
        }
610 
      },
611 
      "x-koha-authorization": {
612 
        "permissions": {
613 
          "catalogue": "1"
614 
        }
615 
      },
616 
      "x-koha-embed": [
617 
        "smtp_server"
618 
      ]
619 
    }
620 
  },
621 
  "/public/libraries/{library_id}": {
622 
    "get": {
623 
      "x-mojo-to": "Libraries#get",
624 
      "operationId": "getLibraryPublic",
625 
      "tags": [
626 
        "libraries"
627 
      ],
628 
      "summary": "Get library (public)",
629 
      "parameters": [
630 
        {
631 
          "$ref": "../parameters.json#/library_id_pp"
632 
        }
633 
      ],
634 
      "produces": [
635 
        "application/json"
636 
      ],
637 
      "responses": {
638 
        "200": {
639 
          "description": "A library"
640 
        },
641 
        "401": {
642 
          "description": "Authentication required",
643 
          "schema": {
644 
            "$ref": "../definitions.json#/error"
645 
          }
646 
        },
647 
        "403": {
648 
          "description": "Access forbidden",
649 
          "schema": {
650 
            "$ref": "../definitions.json#/error"
651 
          }
652 
        },
653 
        "404": {
654 
          "description": "Library not found",
655 
          "schema": {
656 
            "$ref": "../definitions.json#/error"
657 
          }
658 
        },
659 
        "406": {
660 
          "description": "Not acceptable",
661 
          "schema": {
662 
            "type": "array",
663 
            "description": "Accepted content-types",
664 
            "items": {
665 
                "type": "string"
666 
            }
667 
          }
668 
        },
669 
        "500": {
670 
          "description": "Internal server error",
671 
          "schema": {
672 
            "$ref": "../definitions.json#/error"
673 
          }
674 
        },
675 
        "503": {
676 
          "description": "Under maintenance",
677 
          "schema": {
678 
            "$ref": "../definitions.json#/error"
679 
          }
680 
        }
681 
      }
682 
    }
434 
  }
 683 
  }
435 
}
 684 
}
436 
-

Return to bug 28948