Sultan
/
invoiceninja
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updates for documentation

This commit is contained in:
David Bomba 2024-11-18 08:40:35 +11:00
parent e1a1499bc6
commit f49fa617b5
6 changed files with 148 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
openapi/api-docs.yaml
View File

@ -170,6 +170,19 @@ paths:
/api/v1/login: /api/v1/login:
post: post:
x-codeSamples: x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("your_token");
- lang: curl
label: curl
source: |
curl --request POST \
--url 'https://invoicing.co/api/v1/login?include=company,token' \
--header 'X-API-TOKEN: YOUR_API_TOKEN_HERE' \
--header 'X-Requested-With: XMLHttpRequest' \
--header 'Accept: application/json'
tags: tags:
- auth - auth
summary: "Login" summary: "Login"
@ -184,7 +197,16 @@ paths:
- $ref: "#/components/parameters/include_static" - $ref: "#/components/parameters/include_static"
- $ref: "#/components/parameters/clear_cache" - $ref: "#/components/parameters/clear_cache"
requestBody: requestBody:
description: "User credentials" description: |
User credentials
```json
{
"email" : "fred@flintstonze.com",
"password" : "magicpassword123",
"one_time_password" : "12345",
}
```
required: true required: true
content: content:
application/json: application/json:
@ -14748,10 +14770,23 @@ components:
name: include name: include
in: query in: query
description: | description: |
Include child relations of the CompanyUser object, format is comma separated. Include child relations of the CompanyUser object, format is comma separated.
<br />
> ### **Note**: it is possible to chain multiple includes together, ie. include=account,token > ### **Note**: it is possible to chain multiple includes together, ie. include=account,token
<br />
```html
Available includes:
user
company
token
account
```
required: false required: false
schema: schema:
type: string type: string
@ -14796,7 +14831,7 @@ components:
name: include_static name: include_static
in: query in: query
description: | description: |
This include will also return the full set of static variables used in the application including: This include will return the full set of static variables used in the application including:
- Currencies - Currencies
- Countries - Countries
- Languages - Languages
@ -14814,7 +14849,7 @@ components:
description: | description: |
Clears cache Clears cache
Sometimes after a system update where the static variables have been updated, it may be necessary to clear the cache so that the static variables repopulate Clears (and rebuilds) the static variable cache.
required: false required: false
schema: schema:
@ -18527,15 +18562,15 @@ components:
email_template_custom1: email_template_custom1:
description: "Custom reminder template body" description: "Custom reminder template body"
type: string type: string
example: "<HTML>" example: "<HTML></HTML>"
email_template_custom2: email_template_custom2:
description: "Custom reminder template body" description: "Custom reminder template body"
type: string type: string
example: "<HTML>" example: "<HTML></HTML>"
email_template_custom3: email_template_custom3:
description: "Custom reminder template body" description: "Custom reminder template body"
type: string type: string
example: "<HTML>" example: "<HTML></HTML>"
enable_reminder1: enable_reminder1:
description: "Toggles whether this reminder is enabled" description: "Toggles whether this reminder is enabled"
type: boolean type: boolean
@ -21300,7 +21335,7 @@ components:
CompanyUser: CompanyUser:
properties: properties:
permissions: permissions:
description: 'The user permissionsfor this company in a comma separated list' description: 'The user permissions for this company in a comma separated list'
type: string type: string
example: 'create_invoice,create_client,view_client' example: 'create_invoice,create_client,view_client'
settings: settings:
@ -21346,7 +21381,7 @@ components:
CompanyUserRef: CompanyUserRef:
properties: properties:
permissions: permissions:
description: 'The user permissionsfor this company in a comma separated list' description: 'The user permissions for this company in a comma separated list'
type: string type: string
example: 'create_invoice,create_client,view_client' example: 'create_invoice,create_client,view_client'
settings: settings:
@ -22156,6 +22191,7 @@ components:
type: object type: object
tags: tags:
- name: auth - name: auth
x-displayName: Authentication
description: | description: |
Attempts to authenticate with the API using a email/password combination. Attempts to authenticate with the API using a email/password combination.
@ -22168,13 +22204,17 @@ tags:
/api/v1/login?include=company,user /api/v1/login?include=company,user
``` ```
- name: clients - name: clients
x-tag-expanded: false x-displayName: Clients
# description: | # description: |
# Endpoint definitions for interacting with clients. # Endpoint definitions for interacting with clients.
- name: products - name: products
x-displayName: Products
description: | description: |
Endpoint definitions for interacting with products. Endpoint definitions for interacting with products.
- name: invoices - name: invoices
x-displayName: Invoices
description: | description: |
## Invoice Statuses ## Invoice Statuses
@ -22197,41 +22237,65 @@ tags:
- An invoice which is not yet due, but also, not paid - An invoice which is not yet due, but also, not paid
- name: Recurring Invoices - name: Recurring Invoices
x-displayName: Recurring Invoices
description: | description: |
Endpoint definitions for interacting with recurring_invoices. Endpoint definitions for interacting with recurring_invoices.
- name: payments - name: payments
x-displayName: Payments
description: | description: |
Endpoint definitions for interacting with payments. Endpoint definitions for interacting with payments.
- name: quotes - name: quotes
x-displayName:: Quotes
description: | description: |
Endpoint definitions for interacting with quotes. Endpoint definitions for interacting with quotes.
- name: credits - name: credits
x-displayName: Credits
description: | description: |
Endpoint definitions for interacting with credits. Endpoint definitions for interacting with credits.
- name: projects - name: projects
x-displayName: Projects
description: | description: |
Endpoint definitions for interacting with projects. Endpoint definitions for interacting with projects.
- name: tasks - name: tasks
x-displayName: Tasks
description: | description: |
Endpoint definitions for interacting with tasks. Endpoint definitions for interacting with tasks.
- name: vendors - name: vendors
x-displayName: Vendors
description: | description: |
Endpoint definitions for interacting with vendors. Endpoint definitions for interacting with vendors.
- name: Purchase Orders - name: Purchase Orders
x-displayName: Purchase Orders
description: | description: |
Endpoint definitions for interacting with purchase orders. Endpoint definitions for interacting with purchase orders.
- name: expenses - name: expenses
x-displayName: Expenses
description: | description: |
Endpoint definitions for interacting with expenses. Endpoint definitions for interacting with expenses.
- name: recurring_expenses - name: recurring_expenses
x-displayName: Recurring Expenses
description: | description: |
Endpoint definitions for interacting with recurring_expenses. Endpoint definitions for interacting with recurring_expenses.
- name: bank_transactions - name: bank_transactions
x-displayName: Bank Transactions
description: | description: |
Endpoint definitions for interacting with bank transactions. Endpoint definitions for interacting with bank transactions.
- name: reports - name: reports
x-displayName: Reports
description: | description: |
Endpoint definitions for interacting with reports. Endpoint definitions for interacting with reports.
externalDocs: externalDocs:
description: "https://invoiceninja.github.io" description: "https://invoiceninja.github.io"
url: "https://invoiceninja.github.io" url: "https://invoiceninja.github.io"

19
openapi/components/parameters.yaml
View File

@ -116,10 +116,23 @@
name: include name: include
in: query in: query
description: | description: |
Include child relations of the CompanyUser object, format is comma separated. Include child relations of the CompanyUser object, format is comma separated.
<br />
> ### **Note**: it is possible to chain multiple includes together, ie. include=account,token > ### **Note**: it is possible to chain multiple includes together, ie. include=account,token
<br />
```html
Available includes:
user
company
token
account
```
required: false required: false
schema: schema:
type: string type: string
@ -164,7 +177,7 @@
name: include_static name: include_static
in: query in: query
description: | description: |
This include will also return the full set of static variables used in the application including: This include will return the full set of static variables used in the application including:
- Currencies - Currencies
- Countries - Countries
- Languages - Languages
@ -182,7 +195,7 @@
description: | description: |
Clears cache Clears cache
Sometimes after a system update where the static variables have been updated, it may be necessary to clear the cache so that the static variables repopulate Clears (and rebuilds) the static variable cache.
required: false required: false
schema: schema:

6
openapi/components/schemas/company_settings.yaml
View File

@ -535,15 +535,15 @@
email_template_custom1: email_template_custom1:
description: "Custom reminder template body" description: "Custom reminder template body"
type: string type: string
example: "<HTML>" example: "<HTML></HTML>"
email_template_custom2: email_template_custom2:
description: "Custom reminder template body" description: "Custom reminder template body"
type: string type: string
example: "<HTML>" example: "<HTML></HTML>"
email_template_custom3: email_template_custom3:
description: "Custom reminder template body" description: "Custom reminder template body"
type: string type: string
example: "<HTML>" example: "<HTML></HTML>"
enable_reminder1: enable_reminder1:
description: "Toggles whether this reminder is enabled" description: "Toggles whether this reminder is enabled"
type: boolean type: boolean

4
openapi/components/schemas/company_user.yaml
View File

@ -1,7 +1,7 @@
CompanyUser: CompanyUser:
properties: properties:
permissions: permissions:
description: 'The user permissionsfor this company in a comma separated list' description: 'The user permissions for this company in a comma separated list'
type: string type: string
example: 'create_invoice,create_client,view_client' example: 'create_invoice,create_client,view_client'
settings: settings:
@ -47,7 +47,7 @@
CompanyUserRef: CompanyUserRef:
properties: properties:
permissions: permissions:
description: 'The user permissionsfor this company in a comma separated list' description: 'The user permissions for this company in a comma separated list'
type: string type: string
example: 'create_invoice,create_client,view_client' example: 'create_invoice,create_client,view_client'
settings: settings:

31
openapi/misc/misc.yaml
View File

@ -1,5 +1,6 @@
tags: tags:
- name: auth - name: auth
x-displayName: Authentication
description: | description: |
Attempts to authenticate with the API using a email/password combination. Attempts to authenticate with the API using a email/password combination.
@ -12,13 +13,17 @@ tags:
/api/v1/login?include=company,user /api/v1/login?include=company,user
``` ```
- name: clients - name: clients
x-tag-expanded: false x-displayName: Clients
# description: | # description: |
# Endpoint definitions for interacting with clients. # Endpoint definitions for interacting with clients.
- name: products - name: products
x-displayName: Products
description: | description: |
Endpoint definitions for interacting with products. Endpoint definitions for interacting with products.
- name: invoices - name: invoices
x-displayName: Invoices
description: | description: |
## Invoice Statuses ## Invoice Statuses
@ -41,41 +46,65 @@ tags:
- An invoice which is not yet due, but also, not paid - An invoice which is not yet due, but also, not paid
- name: Recurring Invoices - name: Recurring Invoices
x-displayName: Recurring Invoices
description: | description: |
Endpoint definitions for interacting with recurring_invoices. Endpoint definitions for interacting with recurring_invoices.
- name: payments - name: payments
x-displayName: Payments
description: | description: |
Endpoint definitions for interacting with payments. Endpoint definitions for interacting with payments.
- name: quotes - name: quotes
x-displayName:: Quotes
description: | description: |
Endpoint definitions for interacting with quotes. Endpoint definitions for interacting with quotes.
- name: credits - name: credits
x-displayName: Credits
description: | description: |
Endpoint definitions for interacting with credits. Endpoint definitions for interacting with credits.
- name: projects - name: projects
x-displayName: Projects
description: | description: |
Endpoint definitions for interacting with projects. Endpoint definitions for interacting with projects.
- name: tasks - name: tasks
x-displayName: Tasks
description: | description: |
Endpoint definitions for interacting with tasks. Endpoint definitions for interacting with tasks.
- name: vendors - name: vendors
x-displayName: Vendors
description: | description: |
Endpoint definitions for interacting with vendors. Endpoint definitions for interacting with vendors.
- name: Purchase Orders - name: Purchase Orders
x-displayName: Purchase Orders
description: | description: |
Endpoint definitions for interacting with purchase orders. Endpoint definitions for interacting with purchase orders.
- name: expenses - name: expenses
x-displayName: Expenses
description: | description: |
Endpoint definitions for interacting with expenses. Endpoint definitions for interacting with expenses.
- name: recurring_expenses - name: recurring_expenses
x-displayName: Recurring Expenses
description: | description: |
Endpoint definitions for interacting with recurring_expenses. Endpoint definitions for interacting with recurring_expenses.
- name: bank_transactions - name: bank_transactions
x-displayName: Bank Transactions
description: | description: |
Endpoint definitions for interacting with bank transactions. Endpoint definitions for interacting with bank transactions.
- name: reports - name: reports
x-displayName: Reports
description: | description: |
Endpoint definitions for interacting with reports. Endpoint definitions for interacting with reports.
externalDocs: externalDocs:
description: "https://invoiceninja.github.io" description: "https://invoiceninja.github.io"
url: "https://invoiceninja.github.io" url: "https://invoiceninja.github.io"

24
openapi/paths.yaml
View File

@ -87,6 +87,19 @@ paths:
/api/v1/login: /api/v1/login:
post: post:
x-codeSamples: x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("your_token");
- lang: curl
label: curl
source: |
curl --request POST \
--url 'https://invoicing.co/api/v1/login?include=company,token' \
--header 'X-API-TOKEN: YOUR_API_TOKEN_HERE' \
--header 'X-Requested-With: XMLHttpRequest' \
--header 'Accept: application/json'
tags: tags:
- auth - auth
summary: "Login" summary: "Login"
@ -101,7 +114,16 @@ paths:
- $ref: "#/components/parameters/include_static" - $ref: "#/components/parameters/include_static"
- $ref: "#/components/parameters/clear_cache" - $ref: "#/components/parameters/clear_cache"
requestBody: requestBody:
description: "User credentials" description: |
User credentials
```json
{
"email" : "fred@flintstonze.com",
"password" : "magicpassword123",
"one_time_password" : "12345",
}
```
required: true required: true
content: content:
application/json: application/json: