Skip to content

Commit

Permalink
Run ./manage.py pre-commit
Browse files Browse the repository at this point in the history
  • Loading branch information
@duncandewhurst
duncandewhurst committed Nov 10, 2023
1 parent 9137b86 commit fbc6a89
Show file tree
Hide file tree
Showing 2 changed files with 196 additions and 5 deletions.
82 changes: 80 additions & 2 deletions docs/_static/i18n.csv
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,18 +71,18 @@ budget/budgetBreakdown/amount,Amount,False,
budget/budgetBreakdown/amount,Value,False,
budget/budgetBreakdown/amount/amount,Amount,False,
budget/budgetBreakdown/amount/currency,Currency,False,
budget/budgetBreakdown/approvalDate,Approval date,False,
budget/budgetBreakdown/uri,Linked budget information,False,
budget/budgetBreakdown/period,Budget period,False,
budget/budgetBreakdown/period,Period,False,
budget/budgetBreakdown/period/startDate,Start date,False,
budget/budgetBreakdown/period/endDate,End date,False,
budget/budgetBreakdown/period/maxExtentDate,Maximum extent,False,
budget/budgetBreakdown/period/durationInDays,Duration (days),False,
budget/budgetBreakdown/sourceParty,Source party,False,
budget/budgetBreakdown/sourceParty,Source organization,False,
budget/budgetBreakdown/sourceParty,Organization reference,False,
budget/budgetBreakdown/sourceParty/name,Organization name,True,
budget/budgetBreakdown/sourceParty/id,Organization ID,True,
budget/budgetBreakdown/approvalDate,Approval date,False,
forecasts,Forecasts,False,
forecasts,Metric,False,
forecasts/id,Identifier,False,
Expand Down Expand Up @@ -275,6 +275,36 @@ contractingProcesses/summary/transactions/payee,Organization reference,False,
contractingProcesses/summary/transactions/payee/name,Organization name,True,
contractingProcesses/summary/transactions/payee/id,Organization ID,True,
contractingProcesses/summary/transactions/uri,Linked spending information,False,
contractingProcesses/summary/transactions/relatedImplementationMilestone,Related implementation milestone,False,
contractingProcesses/summary/transactions/relatedImplementationMilestone,Milestone Reference,False,
contractingProcesses/summary/transactions/relatedImplementationMilestone/id,Milestone ID,True,
contractingProcesses/summary/transactions/relatedImplementationMilestone/title,Milestone title,True,
contractingProcesses/summary/milestones,Milestones,False,
contractingProcesses/summary/milestones,Milestone,False,
contractingProcesses/summary/milestones/id,ID,True,
contractingProcesses/summary/milestones/title,Title,True,
contractingProcesses/summary/milestones/type,Milestone type,False,
contractingProcesses/summary/milestones/description,Description,True,
contractingProcesses/summary/milestones/code,Milestone code,False,
contractingProcesses/summary/milestones/dueDate,Due date,False,
contractingProcesses/summary/milestones/dateMet,Date met,False,
contractingProcesses/summary/milestones/dateModified,Date modified,False,
contractingProcesses/summary/milestones/status,Status,False,
contractingProcesses/summary/milestones/documents,Documents,False,
contractingProcesses/summary/milestones/documents,Document,False,
contractingProcesses/summary/milestones/documents/id,ID,True,
contractingProcesses/summary/milestones/documents/documentType,Document type,False,
contractingProcesses/summary/milestones/documents/title,Title,True,
contractingProcesses/summary/milestones/documents/description,Description,True,
contractingProcesses/summary/milestones/documents/url,URL,False,
contractingProcesses/summary/milestones/documents/datePublished,Date published,False,
contractingProcesses/summary/milestones/documents/dateModified,Date modified,False,
contractingProcesses/summary/milestones/documents/format,Format,True,
contractingProcesses/summary/milestones/documents/language,Language,True,
contractingProcesses/summary/milestones/documents/pageStart,Page start,True,
contractingProcesses/summary/milestones/documents/pageEnd,Page end,True,
contractingProcesses/summary/milestones/documents/accessDetails,Access details,True,
contractingProcesses/summary/milestones/documents/author,Author,True,
contractingProcesses/releases,Linked releases,False,
contractingProcesses/releases,Release,False,
contractingProcesses/releases/id,ID,True,
Expand Down Expand Up @@ -307,6 +337,54 @@ metrics/observations/unit/id,ID,True,
metrics/observations/unit/uri,URI,False,
metrics/observations/dimensions,Dimensions,False,
metrics/observations/notes,Notes,True,
transactions,Transactions,False,
transactions,Transaction information,False,
transactions/id,ID,True,
transactions/source,Data source,False,
transactions/date,Date,False,
transactions/value,Value,False,
transactions/value,Value,False,
transactions/value/amount,Amount,False,
transactions/value/currency,Currency,False,
transactions/payer,Payer,False,
transactions/payer,Organization reference,False,
transactions/payer/name,Organization name,True,
transactions/payer/id,Organization ID,True,
transactions/payee,Payee,False,
transactions/payee,Organization reference,False,
transactions/payee/name,Organization name,True,
transactions/payee/id,Organization ID,True,
transactions/uri,Linked spending information,False,
transactions/relatedImplementationMilestone,Related implementation milestone,False,
transactions/relatedImplementationMilestone,Milestone Reference,False,
transactions/relatedImplementationMilestone/id,Milestone ID,True,
transactions/relatedImplementationMilestone/title,Milestone title,True,
milestones,Milestones,False,
milestones,Milestone,False,
milestones/id,ID,True,
milestones/title,Title,True,
milestones/type,Milestone type,False,
milestones/description,Description,True,
milestones/code,Milestone code,False,
milestones/dueDate,Due date,False,
milestones/dateMet,Date met,False,
milestones/dateModified,Date modified,False,
milestones/status,Status,False,
milestones/documents,Documents,False,
milestones/documents,Document,False,
milestones/documents/id,ID,True,
milestones/documents/documentType,Document type,False,
milestones/documents/title,Title,True,
milestones/documents/description,Description,True,
milestones/documents/url,URL,False,
milestones/documents/datePublished,Date published,False,
milestones/documents/dateModified,Date modified,False,
milestones/documents/format,Format,True,
milestones/documents/language,Language,True,
milestones/documents/pageStart,Page start,True,
milestones/documents/pageEnd,Page end,True,
milestones/documents/accessDetails,Access details,True,
milestones/documents/author,Author,True,
completion,Completion,False,
completion/endDate,End date,False,
completion/endDateDetails,End date details,True,
Expand Down
119 changes: 116 additions & 3 deletions docs/reference/schema.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Each `ContractingProcessSummary` has the following fields:
```{jsonschema} ../../build/current_lang/project-schema.json
:pointer: /definitions/ContractingProcessSummary
:collapse: ocid,externalReference,nature,title,description,status,suppliers,contractValue,contractPeriod,finalValue,documents,modifications,transactions
:collapse: ocid,externalReference,nature,title,description,status,suppliers,contractValue,contractPeriod,finalValue,documents,modifications,transactions,milestones
:addtargets:
```
Expand Down Expand Up @@ -424,6 +424,11 @@ Each `Value` has the following fields:
:title: contractingProcesses/0/summary/transactions/0/value
```
```{jsoninclude} ../../docs/examples/example.json
:jsonpointer: /projects/0/transactions/0/value
:title: transactions/0/value
```
```{jsoninclude} ../../docs/examples/example.json
:jsonpointer: /projects/0/completion/finalValue
:title: completion/finalValue
Expand Down Expand Up @@ -541,6 +546,16 @@ Each `OrganizationReference` has the following fields:
:title: contractingProcesses/0/summary/transactions/0/payee
```
```{jsoninclude} ../../docs/examples/example.json
:jsonpointer: /projects/0/transactions/0/payer
:title: transactions/0/payer
```
```{jsoninclude} ../../docs/examples/example.json
:jsonpointer: /projects/0/transactions/0/payee
:title: transactions/0/payee
```
````
`````
Expand Down Expand Up @@ -645,7 +660,7 @@ Each `BudgetBreakdown` has the following fields:
```{jsonschema} ../../build/current_lang/project-schema.json
:pointer: /definitions/BudgetBreakdown
:collapse: id,description,amount,approvalDate,uri,period,sourceParty
:collapse: id,description,amount,uri,period,sourceParty,approvalDate
:addtargets:
```
Expand All @@ -672,6 +687,7 @@ Each `BudgetBreakdown` has the following fields:
This sub-schema is referenced by the following properties:
* [`documents`](project-schema.json,,documents)
* [`ContractingProcessSummary/documents`](project-schema.json,/definitions/ContractingProcessSummary,documents)
* [`Milestone/documents`](project-schema.json,/definitions/Milestone,documents)

Each `Document` has the following fields:

Expand Down Expand Up @@ -699,6 +715,16 @@ Each `Document` has the following fields:
:title: contractingProcesses/0/summary/documents
```
```{jsoninclude} ../../docs/examples/example.json
:jsonpointer: /projects/0/contractingProcesses/0/summary/milestones/0/documents
:title: contractingProcesses/0/summary/milestones/0/documents
```
```{jsoninclude} ../../docs/examples/example.json
:jsonpointer: /projects/0/milestones/0/documents
:title: milestones/0/documents
```
````
`````
Expand Down Expand Up @@ -913,6 +939,7 @@ A spending transaction related to a contracting process.
```

This sub-schema is referenced by the following properties:
* [`transactions`](project-schema.json,,transactions)
* [`ContractingProcessSummary/transactions`](project-schema.json,/definitions/ContractingProcessSummary,transactions)

Each `Transaction` has the following fields:
Expand All @@ -923,7 +950,7 @@ Each `Transaction` has the following fields:
```{jsonschema} ../../build/current_lang/project-schema.json
:pointer: /definitions/Transaction
:collapse: id,source,date,value,payer,payee,uri
:collapse: id,source,date,value,payer,payee,uri,relatedImplementationMilestone
:addtargets:
```
Expand All @@ -936,6 +963,11 @@ Each `Transaction` has the following fields:
:title: contractingProcesses/0/summary/transactions
```
```{jsoninclude} ../../docs/examples/example.json
:jsonpointer: /projects/0/transactions
:title: transactions
```
````
`````
Expand Down Expand Up @@ -974,3 +1006,84 @@ Each `SimpleIdentifier` has the following fields:
````
`````

### Milestone

`Milestone` is defined as:

```{field-description} ../../build/current_lang/project-schema.json /definitions/Milestone
```

This sub-schema is referenced by the following properties:
* [`milestones`](project-schema.json,,milestones)
* [`ContractingProcessSummary/milestones`](project-schema.json,/definitions/ContractingProcessSummary,milestones)

Each `Milestone` has the following fields:

`````{tab-set}
````{tab-item} Schema
```{jsonschema} ../../build/current_lang/project-schema.json
:pointer: /definitions/Milestone
:collapse: id,title,type,description,code,dueDate,dateMet,dateModified,status,documents
:addtargets:
```
````
````{tab-item} Examples
```{jsoninclude} ../../docs/examples/example.json
:jsonpointer: /projects/0/contractingProcesses/0/summary/milestones
:title: contractingProcesses/0/summary/milestones
```
```{jsoninclude} ../../docs/examples/example.json
:jsonpointer: /projects/0/milestones
:title: milestones
```
````
`````

### MilestoneReference

`MilestoneReference` is defined as:

```{field-description} ../../build/current_lang/project-schema.json /definitions/MilestoneReference
```

This sub-schema is referenced by the following properties:
* [`Transaction/relatedImplementationMilestone`](project-schema.json,/definitions/Transaction,relatedImplementationMilestone)

Each `MilestoneReference` has the following fields:

`````{tab-set}
````{tab-item} Schema
```{jsonschema} ../../build/current_lang/project-schema.json
:pointer: /definitions/MilestoneReference
:collapse: id,title
:addtargets:
```
````
````{tab-item} Examples
```{jsoninclude} ../../docs/examples/example.json
:jsonpointer: /projects/0/contractingProcesses/0/summary/transactions/0/relatedImplementationMilestone
:title: contractingProcesses/0/summary/transactions/0/relatedImplementationMilestone
```
```{jsoninclude} ../../docs/examples/example.json
:jsonpointer: /projects/0/transactions/0/relatedImplementationMilestone
:title: transactions/0/relatedImplementationMilestone
```
````
`````

0 comments on commit fbc6a89

Please sign in to comment.