Skip to content

Commit

Permalink
Initial OpenAPI NHGIS Implementation (#8)
Browse files Browse the repository at this point in the history
* Added some new deps for OpenAPI integration

* Added OpenAPI integrations

* Yo ho, oh no, a piratin' we go

* Generated functions by OpenAPI

* Placedholder documentation for generated OpenAPI commands

* Handy model includes file

* YAML used to generate NHGIS OpenAPI commands

* Error with the typing for basis; changed to Int64

* Forgive me, a sinner
  • Loading branch information
TheCedarPrince authored Apr 1, 2024
1 parent 77ac151 commit 12e8c49
Show file tree
Hide file tree
Showing 47 changed files with 2,912 additions and 7 deletions.
5 changes: 5 additions & 0 deletions Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,12 @@ version = "0.0.1"

[deps]
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
OpenAPI = "d5e62ea6-ddf3-4d43-8e4c-ad5e6c8bfd7d"
TimeZones = "f269a46b-ccf7-5d73-abea-4c690281aa53"
URIs = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"

[compat]
julia = "1.6"
Expand Down
15 changes: 15 additions & 0 deletions docs/src/DataExtract.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# DataExtract


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**extractDefinition** | [***DataExtractExtractDefinition**](DataExtractExtractDefinition.md) | | [optional] [default to nothing]
**number** | **Int64** | | [optional] [default to nothing]
**status** | **String** | | [optional] [default to nothing]
**downloadLinks** | [***DataExtractDownloadLinks**](DataExtractDownloadLinks.md) | | [optional] [default to nothing]


[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)


14 changes: 14 additions & 0 deletions docs/src/DataExtractDownloadLinks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# DataExtractDownloadLinks


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**codebookPreview** | **String** | | [optional] [default to nothing]
**tableData** | **String** | | [optional] [default to nothing]
**gisData** | **String** | | [optional] [default to nothing]


[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)


21 changes: 21 additions & 0 deletions docs/src/DataExtractExtractDefinition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# DataExtractExtractDefinition


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**datasets** | [**Dict{String, Dataset}**](Dataset.md) | | [optional] [default to nothing]
**timeSeriesTables** | [**Dict{String, TimeSeriesTable}**](TimeSeriesTable.md) | | [optional] [default to nothing]
**dataFormat** | **String** | | [optional] [default to nothing]
**timeSeriesTableLayout** | **String** | | [optional] [default to nothing]
**breakdownAndDataTypeLayout** | **String** | | [optional] [default to nothing]
**shapefiles** | **Vector{String}** | | [optional] [default to nothing]
**geographicExtents** | **Vector{String}** | | [optional] [default to nothing]
**description** | **String** | | [optional] [default to nothing]
**version** | **Int64** | | [optional] [default to nothing]
**collection** | **String** | | [optional] [default to nothing]


[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)


19 changes: 19 additions & 0 deletions docs/src/DataExtractPost.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# DataExtractPost


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**datasets** | [**Dict{String, Dataset}**](Dataset.md) | | [optional] [default to nothing]
**timeSeriesTables** | [**Dict{String, TimeSeriesTable}**](TimeSeriesTable.md) | | [optional] [default to nothing]
**dataFormat** | **String** | | [optional] [default to nothing]
**timeSeriesTableLayout** | **String** | | [optional] [default to nothing]
**breakdownAndDataTypeLayout** | **String** | | [optional] [default to nothing]
**shapefiles** | **Vector{String}** | | [optional] [default to nothing]
**geographicExtents** | **Vector{String}** | | [optional] [default to nothing]
**description** | **String** | | [optional] [default to nothing]


[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)


15 changes: 15 additions & 0 deletions docs/src/DataExtractPostResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# DataExtractPostResponse


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**extractDefinition** | [***DataExtractExtractDefinition**](DataExtractExtractDefinition.md) | | [optional] [default to nothing]
**number** | **Int64** | | [optional] [default to nothing]
**status** | **String** | | [optional] [default to nothing]
**downloadLinks** | [***DataExtractDownloadLinks**](DataExtractDownloadLinks.md) | | [optional] [default to nothing]


[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)


18 changes: 18 additions & 0 deletions docs/src/DataTableFull.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# DataTableFull


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional] [default to nothing]
**nhgisCode** | **String** | | [optional] [default to nothing]
**description** | **String** | | [optional] [default to nothing]
**universe** | **String** | | [optional] [default to nothing]
**sequence** | **Int64** | | [optional] [default to nothing]
**datasetName** | **String** | | [optional] [default to nothing]
**variables** | [**Vector{DataTableFullVariablesInner}**](DataTableFullVariablesInner.md) | | [optional] [default to nothing]


[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)


13 changes: 13 additions & 0 deletions docs/src/DataTableFullVariablesInner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# DataTableFullVariablesInner


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional] [default to nothing]
**nhgisCode** | **String** | | [optional] [default to nothing]


[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)


15 changes: 15 additions & 0 deletions docs/src/DataTableSimple.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# DataTableSimple


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional] [default to nothing]
**nhgisCode** | **String** | | [optional] [default to nothing]
**description** | **String** | | [optional] [default to nothing]
**sequence** | **Int64** | | [optional] [default to nothing]


[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)


15 changes: 15 additions & 0 deletions docs/src/Dataset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Dataset


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**dataTables** | **Vector{String}** | | [default to nothing]
**geogLevels** | **Vector{String}** | | [default to nothing]
**breakdownValues** | **Vector{String}** | | [optional] [default to nothing]
**years** | **Vector{String}** | | [optional] [default to nothing]


[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)


19 changes: 19 additions & 0 deletions docs/src/DatasetFull.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# DatasetFull


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional] [default to nothing]
**description** | **String** | | [optional] [default to nothing]
**group** | **String** | | [optional] [default to nothing]
**sequence** | **Int64** | | [optional] [default to nothing]
**dataTables** | [**Vector{DataTableSimple}**](DataTableSimple.md) | | [optional] [default to nothing]
**geogLevels** | [**Vector{DatasetFullGeogLevelsInner}**](DatasetFullGeogLevelsInner.md) | | [optional] [default to nothing]
**hasMultipleDataTypes** | **Bool** | | [optional] [default to nothing]
**breakdowns** | [***DatasetFullBreakdowns**](DatasetFullBreakdowns.md) | | [optional] [default to nothing]


[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)


17 changes: 17 additions & 0 deletions docs/src/DatasetFullBreakdowns.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# DatasetFullBreakdowns


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional] [default to nothing]
**type** | **String** | | [optional] [default to nothing]
**description** | **String** | | [optional] [default to nothing]
**breakdownValues** | [**Vector{DatasetFullBreakdownsBreakdownValuesInner}**](DatasetFullBreakdownsBreakdownValuesInner.md) | | [optional] [default to nothing]
**years** | **Vector{String}** | | [optional] [default to nothing]
**geographicInstances** | [**Vector{DatasetFullBreakdownsBreakdownValuesInner}**](DatasetFullBreakdownsBreakdownValuesInner.md) | | [optional] [default to nothing]


[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)


13 changes: 13 additions & 0 deletions docs/src/DatasetFullBreakdownsBreakdownValuesInner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# DatasetFullBreakdownsBreakdownValuesInner


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional] [default to nothing]
**description** | **String** | | [optional] [default to nothing]


[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)


14 changes: 14 additions & 0 deletions docs/src/DatasetFullGeogLevelsInner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# DatasetFullGeogLevelsInner


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional] [default to nothing]
**description** | **String** | | [optional] [default to nothing]
**hasGeogExtentSelection** | **Bool** | | [optional] [default to nothing]


[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)


15 changes: 15 additions & 0 deletions docs/src/DatasetSimple.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# DatasetSimple


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional] [default to nothing]
**description** | **String** | | [optional] [default to nothing]
**group** | **String** | | [optional] [default to nothing]
**sequence** | **Int64** | | [optional] [default to nothing]


[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)


Loading

0 comments on commit 12e8c49

Please sign in to comment.