Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-07-08 17:24:29 -04:00
Code Issues Packages Projects Releases Wiki Activity

Better use of tags in openapi docs

Browse Source
This commit is contained in:
David Bomba 2023-02-19 16:48:54 +11:00
parent 8e59dfbfcb
commit 49d08b279e
3 changed files with 27 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
openapi/api-docs.yaml
View File

@ -10182,7 +10182,7 @@ paths:
/api/v1/purchase_orders: /api/v1/purchase_orders:
get: get:
tags: tags:
- purchase_orders - Purchase Orders
summary: "List purchase orders" summary: "List purchase orders"
description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available"
operationId: getPurchaseOrders operationId: getPurchaseOrders
@ -10214,7 +10214,7 @@ paths:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
post: post:
tags: tags:
- purhcase_orders - Purchase Orders
summary: "Create purchase order" summary: "Create purchase order"
description: "Adds an purchase order to the system" description: "Adds an purchase order to the system"
operationId: storePurchaseOrder operationId: storePurchaseOrder
@ -10248,8 +10248,8 @@ paths:
"/api/v1/purchase_orders/{id}": "/api/v1/purchase_orders/{id}":
get: get:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Show purcase order" summary: "Show purchase order"
description: "Displays an purchase order by id" description: "Displays an purchase order by id"
operationId: showPurchaseOrder operationId: showPurchaseOrder
parameters: parameters:
@ -10289,7 +10289,7 @@ paths:
"/api/v1/purchase_order/{id}": "/api/v1/purchase_order/{id}":
put: put:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Update purchase order" summary: "Update purchase order"
description: "Handles the updating of an purchase order by id" description: "Handles the updating of an purchase order by id"
operationId: updatePurchaseOrder operationId: updatePurchaseOrder
@ -10329,7 +10329,7 @@ paths:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
delete: delete:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Delete purchase order" summary: "Delete purchase order"
description: "Handles the deletion of an purchase orders by id" description: "Handles the deletion of an purchase orders by id"
operationId: deletePurchaseOrder operationId: deletePurchaseOrder
@ -10366,7 +10366,7 @@ paths:
"/api/v1/purchase_orders/{id}/edit": "/api/v1/purchase_orders/{id}/edit":
get: get:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Edit purchase order" summary: "Edit purchase order"
description: "Displays an purchase order by id" description: "Displays an purchase order by id"
operationId: editPurchaseOrder operationId: editPurchaseOrder
@ -10408,7 +10408,7 @@ paths:
/api/v1/purchase_orders/create: /api/v1/purchase_orders/create:
get: get:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Blank purchase order" summary: "Blank purchase order"
description: "Returns a blank object with default values" description: "Returns a blank object with default values"
operationId: getPurchaseOrderCreate operationId: getPurchaseOrderCreate
@ -10441,7 +10441,7 @@ paths:
/api/v1/purchase_orders/bulk: /api/v1/purchase_orders/bulk:
post: post:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Bulk purchase order action" summary: "Bulk purchase order action"
description: "" description: ""
operationId: bulkPurchaseOrderss operationId: bulkPurchaseOrderss
@ -10482,7 +10482,7 @@ paths:
get: get:
deprecated: true deprecated: true
tags: tags:
- purchase_orders - Purchase Orders
summary: "Custom purchase order actions" summary: "Custom purchase order actions"
description: "Performs a custom action on an purchase order.\n *\n * The current range of actions are as follows\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email" description: "Performs a custom action on an purchase order.\n *\n * The current range of actions are as follows\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email"
operationId: actionPurchaseOrder operationId: actionPurchaseOrder
@ -10531,7 +10531,7 @@ paths:
"/api/v1/purchase_orders/{id}/upload": "/api/v1/purchase_orders/{id}/upload":
put: put:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Uploads a purchase order document" summary: "Uploads a purchase order document"
description: "Handles the uploading of a document to a purchase_order" description: "Handles the uploading of a document to a purchase_order"
operationId: uploadPurchaseOrder operationId: uploadPurchaseOrder
@ -10572,7 +10572,7 @@ paths:
"/api/v1/purchase_order/{invitation_key}/download": "/api/v1/purchase_order/{invitation_key}/download":
get: get:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Download a purchase order PDF" summary: "Download a purchase order PDF"
description: "Downloads a specific purchase order" description: "Downloads a specific purchase order"
operationId: downloadPurchaseOrder operationId: downloadPurchaseOrder
@ -17300,7 +17300,8 @@ tags:
- name: vendors - name: vendors
description: | description: |
Endpoint definitions for interacting with vendors. Endpoint definitions for interacting with vendors.
- name: purchase_orders - name: Purchase Orders
summary: Purchase Orders
description: | description: |
Endpoint definitions for interacting with purchase orders. Endpoint definitions for interacting with purchase orders.
- name: expenses - name: expenses

3
openapi/misc/misc.yaml
View File

@ -35,7 +35,8 @@ tags:
- name: vendors - name: vendors
description: | description: |
Endpoint definitions for interacting with vendors. Endpoint definitions for interacting with vendors.
- name: purchase_orders - name: Purchase Orders
summary: Purchase Orders
description: | description: |
Endpoint definitions for interacting with purchase orders. Endpoint definitions for interacting with purchase orders.
- name: expenses - name: expenses

22
openapi/paths/purchase_orders.yaml
View File

@ -1,7 +1,7 @@
/api/v1/purchase_orders: /api/v1/purchase_orders:
get: get:
tags: tags:
- purchase_orders - Purchase Orders
summary: "List purchase orders" summary: "List purchase orders"
description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available"
operationId: getPurchaseOrders operationId: getPurchaseOrders
@ -33,7 +33,7 @@
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
post: post:
tags: tags:
- purhcase_orders - Purchase Orders
summary: "Create purchase order" summary: "Create purchase order"
description: "Adds an purchase order to the system" description: "Adds an purchase order to the system"
operationId: storePurchaseOrder operationId: storePurchaseOrder
@ -67,7 +67,7 @@
"/api/v1/purchase_orders/{id}": "/api/v1/purchase_orders/{id}":
get: get:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Show purchase order" summary: "Show purchase order"
description: "Displays an purchase order by id" description: "Displays an purchase order by id"
operationId: showPurchaseOrder operationId: showPurchaseOrder
@ -108,7 +108,7 @@
"/api/v1/purchase_order/{id}": "/api/v1/purchase_order/{id}":
put: put:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Update purchase order" summary: "Update purchase order"
description: "Handles the updating of an purchase order by id" description: "Handles the updating of an purchase order by id"
operationId: updatePurchaseOrder operationId: updatePurchaseOrder
@ -148,7 +148,7 @@
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
delete: delete:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Delete purchase order" summary: "Delete purchase order"
description: "Handles the deletion of an purchase orders by id" description: "Handles the deletion of an purchase orders by id"
operationId: deletePurchaseOrder operationId: deletePurchaseOrder
@ -185,7 +185,7 @@
"/api/v1/purchase_orders/{id}/edit": "/api/v1/purchase_orders/{id}/edit":
get: get:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Edit purchase order" summary: "Edit purchase order"
description: "Displays an purchase order by id" description: "Displays an purchase order by id"
operationId: editPurchaseOrder operationId: editPurchaseOrder
@ -227,7 +227,7 @@
/api/v1/purchase_orders/create: /api/v1/purchase_orders/create:
get: get:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Blank purchase order" summary: "Blank purchase order"
description: "Returns a blank object with default values" description: "Returns a blank object with default values"
operationId: getPurchaseOrderCreate operationId: getPurchaseOrderCreate
@ -260,7 +260,7 @@
/api/v1/purchase_orders/bulk: /api/v1/purchase_orders/bulk:
post: post:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Bulk purchase order action" summary: "Bulk purchase order action"
description: "" description: ""
operationId: bulkPurchaseOrderss operationId: bulkPurchaseOrderss
@ -301,7 +301,7 @@
get: get:
deprecated: true deprecated: true
tags: tags:
- purchase_orders - Purchase Orders
summary: "Custom purchase order actions" summary: "Custom purchase order actions"
description: "Performs a custom action on an purchase order.\n *\n * The current range of actions are as follows\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email" description: "Performs a custom action on an purchase order.\n *\n * The current range of actions are as follows\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email"
operationId: actionPurchaseOrder operationId: actionPurchaseOrder
@ -350,7 +350,7 @@
"/api/v1/purchase_orders/{id}/upload": "/api/v1/purchase_orders/{id}/upload":
put: put:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Uploads a purchase order document" summary: "Uploads a purchase order document"
description: "Handles the uploading of a document to a purchase_order" description: "Handles the uploading of a document to a purchase_order"
operationId: uploadPurchaseOrder operationId: uploadPurchaseOrder
@ -391,7 +391,7 @@
"/api/v1/purchase_order/{invitation_key}/download": "/api/v1/purchase_order/{invitation_key}/download":
get: get:
tags: tags:
- purchase_orders - Purchase Orders
summary: "Download a purchase order PDF" summary: "Download a purchase order PDF"
description: "Downloads a specific purchase order" description: "Downloads a specific purchase order"
operationId: downloadPurchaseOrder operationId: downloadPurchaseOrder