Attachment #121453 for bug #28463

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




      "x-mojo-to": "Config::SMTP::Servers#list",
      "operationId": "listSMTPServers",
      "tags": [
        "smtp_servers"
      ],
      "produces": [
        "application/json"

      "x-mojo-to": "Config::SMTP::Servers#add",
      "operationId": "addSMTPServer",
      "tags": [
        "smtp_servers"
      ],
      "parameters": [
        {

      "x-mojo-to": "Config::SMTP::Servers#get",
      "operationId": "getSMTPServer",
      "tags": [
        "smtp_servers"
      ],
      "parameters": [
        {

      "x-mojo-to": "Config::SMTP::Servers#update",
      "operationId": "updateSMTPServer",
      "tags": [
        "smtp_servers"
      ],
      "parameters": [
        {

      "x-mojo-to": "Config::SMTP::Servers#delete",
      "operationId": "deleteSMTPServer",
      "tags": [
        "smtp_servers"
      ],
      "parameters": [
        {




      "x-mojo-to": "ImportBatchProfiles#list",
      "operationId": "listImportBatchProfiles",
      "tags": [
        "batch_import_profiles"
      ],
      "parameters": [
        {

      "x-mojo-to": "ImportBatchProfiles#add",
      "operationId": "addImportBatchProfiles",
      "tags": [
        "batch_import_profiles"
      ],
      "parameters": [
        {

      "x-mojo-to": "ImportBatchProfiles#edit",
      "operationId": "editImportBatchProfiles",
      "tags": [
        "batch_import_profiles"
      ],
      "parameters": [
        {

    "delete": {
      "x-mojo-to": "ImportBatchProfiles#delete",
      "operationId": "deleteImportBatchProfiles",
      "tags": ["batch_import_profiles"],
      "parameters": [{
          "$ref": "../parameters.json#/import_batch_profile_id_pp"
        }

Lines 4-10 Link Here

(-)a/api/v1/swagger/paths/patrons_account.json (-2 / +2 lines)
4	"x-mojo-to": "Patrons::Account#get",	4	"x-mojo-to": "Patrons::Account#get",
5	"operationId": "getPatronAccount",	5	"operationId": "getPatronAccount",
6	"tags": [	6	"tags": [
7	"patron"	7	"patrons"
8	],	8	],
9	"parameters": [	9	"parameters": [
10	{	10	{
Lines 65-71 Link Here
65	"x-mojo-to": "Patrons::Account#add_credit",	65	"x-mojo-to": "Patrons::Account#add_credit",
66	"operationId": "addPatronCredit",	66	"operationId": "addPatronCredit",
67	"tags": [	67	"tags": [
68	"patron"	68	"patrons"
69	],	69	],
70	"parameters": [	70	"parameters": [
71	{	71	{

Lines 4-10 Link Here

(-)a/api/v1/swagger/paths/patrons_password.json (-1 / +1 lines)
4	"x-mojo-to": "Patrons::Password#set",	4	"x-mojo-to": "Patrons::Password#set",
5	"operationId": "setPatronPassword",	5	"operationId": "setPatronPassword",
6	"tags": [	6	"tags": [
7	"patron"	7	"patrons"
8	],	8	],
9	"parameters": [	9	"parameters": [
10	{	10	{




            "x-mojo-to": "Patrons::Password#set_public",
            "operationId": "setPatronPasswordPublic",
            "tags": [
                "patrons"
            ],
            "parameters": [
                {

            "x-mojo-to": "Patrons#guarantors_can_see_charges",
            "operationId": "setPatronGuarantorsCanSeeCharges",
            "tags": [
                "patrons"
            ],
            "parameters": [
                {

            "x-mojo-to": "Patrons#guarantors_can_see_checkouts",
            "operationId": "setPatronGuarantorsCanSeeCheckouts",
            "tags": [
                "patrons"
            ],
            "parameters": [
                {




      "operationId": "claimReturned",
      "summary": "Add a return claim",
      "tags": [
        "return_claims"
      ],
      "parameters": [
        {

      "operationId": "updateClaimNotes",
      "summary": "Update notes",
      "tags": [
        "return_claims"
      ],
      "parameters": [
        {

      "x-mojo-to": "ReturnClaims#delete_claim",
      "operationId": "deletedClaim",
      "summary": "Delete claim",
      "tags": [ "return_claims" ],
      "parameters": [
        {
          "name": "claim_id",

      "x-mojo-to": "ReturnClaims#resolve_claim",
      "operationId": "updateClaimResolve",
      "summary": "Resolve claim",
      "tags": [ "return_claims" ],
      "parameters": [
        {
          "name": "claim_id",




    This optional header should be passed to give your api request a library
    context; If it is not included in the request, then the request context
    will default to using your api comsumer's assigned home library.
tags:
  - name: "biblios"
    x-displayName: Biblios
    description: |
      Manage bibliographic records
  - name: "cashups"
    x-displayName: Cashups
    description: |
      Manage cash register cashups
  - name: "checkouts"
    x-displayName: Checkouts
    description: |
      Manage checkouts
  - name: "cities"
    x-displayName: Cities
    description: |
      Manage cities
  - name: "clubs"
    x-displayName: Clubs
    description: |
      Manage patron clubs
  - name: "funds"
    x-displayName: Funds
    description: |
      Manage funds for the acquisitions module
  - name: "holds"
    x-displayName: Holds
    description: |
      Manage holds
  - name: "illbackends"
    x-displayName: ILL backends
    description: |
      Manage ILL module backends
  - name: "illrequests"
    x-displayName: ILL requests
    description: |
      Manage ILL requests
  - name: "items"
    x-displayName: Items
    description: |
      Manage items
  - name: "library"
    x-displayName: Libraries
    description: |
      Manage libraries
  - name: "orders"
    x-displayName: Orders
    description: |
      Manage acquisition orders
  - name: "oauth"
    x-displayName: "OAuth"
    description: |
      Handle OAuth flows
  - name: "patrons"
    x-displayName: Patrons
    description: |
      Manage patrons
  - name: "quotes"
    x-displayName: Quotes
    description: |
      Manage quotes
  - name: "return_claims"
    x-displayName: Return claims
    description: |
      Manage return claims
  - name: "smtp_servers"
    x-displayName: SMTP servers
    description: |
      Manage SMTP servers configurations
  - name: "transfer"
    x-displayName: Transfer limits
    description: |
      Manage transfer limits
  - name: "vendors"
    x-displayName: "Vendors"
    description: |
      Manage vendors for the acquisitions module
  - name: "batch_import_profiles"
    x-displayName: Batch import profiles
    description: |
      Manage batch import profiles

Return to bug 28463

Lines 4-10 Link Here

(-)a/api/v1/swagger/paths/config_smtp_servers.json (-5 / +5 lines)
4	"x-mojo-to": "Config::SMTP::Servers#list",	4	"x-mojo-to": "Config::SMTP::Servers#list",
5	"operationId": "listSMTPServers",	5	"operationId": "listSMTPServers",
6	"tags": [	6	"tags": [
7	"SMTP servers"	7	"smtp_servers"
8	],	8	],
9	"produces": [	9	"produces": [
10	"application/json"	10	"application/json"
Lines 71-77 Link Here
71	"x-mojo-to": "Config::SMTP::Servers#add",	71	"x-mojo-to": "Config::SMTP::Servers#add",
72	"operationId": "addSMTPServer",	72	"operationId": "addSMTPServer",
73	"tags": [	73	"tags": [
74	"SMTP servers"	74	"smtp_servers"
75	],	75	],
76	"parameters": [	76	"parameters": [
77	{	77	{
Lines 137-143 Link Here
137	"x-mojo-to": "Config::SMTP::Servers#get",	137	"x-mojo-to": "Config::SMTP::Servers#get",
138	"operationId": "getSMTPServer",	138	"operationId": "getSMTPServer",
139	"tags": [	139	"tags": [
140	"SMTP servers"	140	"smtp_servers"
141	],	141	],
142	"parameters": [	142	"parameters": [
143	{	143	{
Lines 189-195 Link Here
189	"x-mojo-to": "Config::SMTP::Servers#update",	189	"x-mojo-to": "Config::SMTP::Servers#update",
190	"operationId": "updateSMTPServer",	190	"operationId": "updateSMTPServer",
191	"tags": [	191	"tags": [
192	"SMTP servers"	192	"smtp_servers"
193	],	193	],
194	"parameters": [	194	"parameters": [
195	{	195	{
Lines 256-262 Link Here
256	"x-mojo-to": "Config::SMTP::Servers#delete",	256	"x-mojo-to": "Config::SMTP::Servers#delete",
257	"operationId": "deleteSMTPServer",	257	"operationId": "deleteSMTPServer",
258	"tags": [	258	"tags": [
259	"SMTP servers"	259	"smtp_servers"
260	],	260	],
261	"parameters": [	261	"parameters": [
262	{	262	{

Lines 4-10 Link Here

(-)a/api/v1/swagger/paths/import_batch_profiles.json (-4 / +4 lines)
4	"x-mojo-to": "ImportBatchProfiles#list",	4	"x-mojo-to": "ImportBatchProfiles#list",
5	"operationId": "listImportBatchProfiles",	5	"operationId": "listImportBatchProfiles",
6	"tags": [	6	"tags": [
7	"ImportBatchProfiles"	7	"batch_import_profiles"
8	],	8	],
9	"parameters": [	9	"parameters": [
10	{	10	{
Lines 75-81 Link Here
75	"x-mojo-to": "ImportBatchProfiles#add",	75	"x-mojo-to": "ImportBatchProfiles#add",
76	"operationId": "addImportBatchProfiles",	76	"operationId": "addImportBatchProfiles",
77	"tags": [	77	"tags": [
78	"ImportBatchProfiles"	78	"batch_import_profiles"
79	],	79	],
80	"parameters": [	80	"parameters": [
81	{	81	{
Lines 193-199 Link Here
193	"x-mojo-to": "ImportBatchProfiles#edit",	193	"x-mojo-to": "ImportBatchProfiles#edit",
194	"operationId": "editImportBatchProfiles",	194	"operationId": "editImportBatchProfiles",
195	"tags": [	195	"tags": [
196	"ImportBatchProfiles"	196	"batch_import_profiles"
197	],	197	],
198	"parameters": [	198	"parameters": [
199	{	199	{
Lines 311-317 Link Here
311	"delete": {	311	"delete": {
312	"x-mojo-to": "ImportBatchProfiles#delete",	312	"x-mojo-to": "ImportBatchProfiles#delete",
313	"operationId": "deleteImportBatchProfiles",	313	"operationId": "deleteImportBatchProfiles",
314	"tags": ["ImportBatchProfiles"],	314	"tags": ["batch_import_profiles"],
315	"parameters": [{	315	"parameters": [{
316	"$ref": "../parameters.json#/import_batch_profile_id_pp"	316	"$ref": "../parameters.json#/import_batch_profile_id_pp"
317	}	317	}

Lines 5-11 Link Here

(-)a/api/v1/swagger/paths/return_claims.json (-4 / +4 lines)
5	"operationId": "claimReturned",	5	"operationId": "claimReturned",
6	"summary": "Add a return claim",	6	"summary": "Add a return claim",
7	"tags": [	7	"tags": [
8	"Return claims"	8	"return_claims"
9	],	9	],
10	"parameters": [	10	"parameters": [
11	{	11	{
Lines 103-109 Link Here
103	"operationId": "updateClaimNotes",	103	"operationId": "updateClaimNotes",
104	"summary": "Update notes",	104	"summary": "Update notes",
105	"tags": [	105	"tags": [
106	"Return claims"	106	"return_claims"
107	],	107	],
108	"parameters": [	108	"parameters": [
109	{	109	{
Lines 193-199 Link Here
193	"x-mojo-to": "ReturnClaims#delete_claim",	193	"x-mojo-to": "ReturnClaims#delete_claim",
194	"operationId": "deletedClaim",	194	"operationId": "deletedClaim",
195	"summary": "Delete claim",	195	"summary": "Delete claim",
196	"tags": [ "Return claims" ],	196	"tags": [ "return_claims" ],
197	"parameters": [	197	"parameters": [
198	{	198	{
199	"name": "claim_id",	199	"name": "claim_id",
Lines 262-268 Link Here
262	"x-mojo-to": "ReturnClaims#resolve_claim",	262	"x-mojo-to": "ReturnClaims#resolve_claim",
263	"operationId": "updateClaimResolve",	263	"operationId": "updateClaimResolve",
264	"summary": "Resolve claim",	264	"summary": "Resolve claim",
265	"tags": [ "Return claims" ],	265	"tags": [ "return_claims" ],
266	"parameters": [	266	"parameters": [
267	{	267	{
268	"name": "claim_id",	268	"name": "claim_id",

Lines 4-10 Link Here

(-)a/api/v1/swagger/paths/public_patrons.json (-3 / +3 lines)
4	"x-mojo-to": "Patrons::Password#set_public",	4	"x-mojo-to": "Patrons::Password#set_public",
5	"operationId": "setPatronPasswordPublic",	5	"operationId": "setPatronPasswordPublic",
6	"tags": [	6	"tags": [
7	"patron"	7	"patrons"
8	],	8	],
9	"parameters": [	9	"parameters": [
10	{	10	{
Lines 93-99 Link Here
93	"x-mojo-to": "Patrons#guarantors_can_see_charges",	93	"x-mojo-to": "Patrons#guarantors_can_see_charges",
94	"operationId": "setPatronGuarantorsCanSeeCharges",	94	"operationId": "setPatronGuarantorsCanSeeCharges",
95	"tags": [	95	"tags": [
96	"patron"	96	"patrons"
97	],	97	],
98	"parameters": [	98	"parameters": [
99	{	99	{
Lines 169-175 Link Here
169	"x-mojo-to": "Patrons#guarantors_can_see_checkouts",	169	"x-mojo-to": "Patrons#guarantors_can_see_checkouts",
170	"operationId": "setPatronGuarantorsCanSeeCheckouts",	170	"operationId": "setPatronGuarantorsCanSeeCheckouts",
171	"tags": [	171	"tags": [
172	"patron"	172	"patrons"
173	],	173	],
174	"parameters": [	174	"parameters": [
175	{	175	{

Lines 30-32 info: Link Here

(-)a/api/v1/swagger/swagger.yaml (-1 / +81 lines)
30	This optional header should be passed to give your api request a library	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	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.	32	will default to using your api comsumer's assigned home library.
33	-	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: "cities"
		47	x-displayName: Cities
		48	description: \|
		49	Manage cities
		50	- name: "clubs"
		51	x-displayName: Clubs
		52	description: \|
		53	Manage patron clubs
		54	- name: "funds"
		55	x-displayName: Funds
		56	description: \|
		57	Manage funds for the acquisitions module
		58	- name: "holds"
		59	x-displayName: Holds
		60	description: \|
		61	Manage holds
		62	- name: "illbackends"
		63	x-displayName: ILL backends
		64	description: \|
		65	Manage ILL module backends
		66	- name: "illrequests"
		67	x-displayName: ILL requests
		68	description: \|
		69	Manage ILL requests
		70	- name: "items"
		71	x-displayName: Items
		72	description: \|
		73	Manage items
		74	- name: "library"
		75	x-displayName: Libraries
		76	description: \|
		77	Manage libraries
		78	- name: "orders"
		79	x-displayName: Orders
		80	description: \|
		81	Manage acquisition orders
		82	- name: "oauth"
		83	x-displayName: "OAuth"
		84	description: \|
		85	Handle OAuth flows
		86	- name: "patrons"
		87	x-displayName: Patrons
		88	description: \|
		89	Manage patrons
		90	- name: "quotes"
		91	x-displayName: Quotes
		92	description: \|
		93	Manage quotes
		94	- name: "return_claims"
		95	x-displayName: Return claims
		96	description: \|
		97	Manage return claims
98	- name: "smtp_servers"
99	x-displayName: SMTP servers
100	description: \|
101	Manage SMTP servers configurations
102	- name: "transfer"
103	x-displayName: Transfer limits
104	description: \|
105	Manage transfer limits
106	- name: "vendors"
107	x-displayName: "Vendors"
108	description: \|
109	Manage vendors for the acquisitions module
110	- name: "batch_import_profiles"
111	x-displayName: Batch import profiles
112	description: \|
113	Manage batch import profiles