Add schema.ignores option to allow excluding attributes from mapping (#87)

* add edgecase

* add gist (not working without ignores)

* fix with ignores

* add more ignores

* add edgecase ignores

* add config definition

* add data source + element type ignores

* add to provider schema

* add resource and provider implementations

* remove todos

* add config test entries

* add parse validation and tests

* add tests for ignores

* add tests for schema methods

* add changelog

Author: austinvalle

.changes/unreleased/FEATURES-20231026-162053.yaml

@@ -0,0 +1,6 @@
+kind: FEATURES
+body: Added schema.ignores option to generator config for resources, data sources,
+  and providers. Allows excluding attributes from OAS mapping
+time: 2023-10-26T16:20:53.404821-04:00
+custom:
+  Issue: "81"

internal/cmd/testdata/edgecase/generator_config.yml

@@ -1,6 +1,9 @@
 provider:
   name: edgecase
   schema_ref: '#/components/schemas/edgecase_provider'
+  ignores:
+    - triple_nested_map.ignore_me_1
+    - triple_nested_map.obj_prop.ignore_me_2
 
 resources:
   set_test:
@@ -10,6 +13,10 @@ resources:
     read:
       path: /set_test
       method: GET
+    schema:
+      ignores:
+        - setnested_prop.string_prop
+
   map_test:
     create:
       path: /map_test
@@ -23,6 +30,11 @@ data_sources:
     read:
       path: /nested_collections
       method: GET
+    schema:
+      ignores:
+        - triple_nested_map.ignore_me_1
+        - triple_nested_map.obj_prop.ignore_me_2
+
   set_test:
     read:
       path: /set_test

internal/cmd/testdata/edgecase/openapi_spec.yml

@@ -175,6 +175,19 @@ components:
               bool_prop:
                 description: Bool inside a map!
                 type: boolean
+              ignore_me_1:
+                description: This property will be ignored!
+                type: string
+              obj_prop:
+                description: Object inside a map!
+                type: object
+                properties:
+                  number_prop:
+                    description: Number inside a map!
+                    type: number
+                  ignore_me_2:
+                    description: This property will be ignored!
+                    type: string
     setnested_schema:
       description: This is a set with a nested object
       type: array

internal/cmd/testdata/edgecase/provider_code_spec.json

@@ -103,6 +103,17 @@
 															"name": "bool_prop",
 															"bool": {}
 														},
+														{
+															"name": "obj_prop",
+															"object": {
+																"attribute_types": [
+																	{
+																		"name": "number_prop",
+																		"number": {}
+																	}
+																]
+															}
+														},
 														{
 															"name": "string_prop",
 															"string": {}
@@ -225,6 +236,17 @@
 														"name": "bool_prop",
 														"bool": {}
 													},
+													{
+														"name": "obj_prop",
+														"object": {
+															"attribute_types": [
+																{
+																	"name": "number_prop",
+																	"number": {}
+																}
+															]
+														}
+													},
 													{
 														"name": "string_prop",
 														"string": {}
@@ -311,13 +333,6 @@
 											"computed_optional_required": "computed_optional",
 											"description": "Bool inside a set!"
 										}
-									},
-									{
-										"name": "string_prop",
-										"string": {
-											"computed_optional_required": "computed_optional",
-											"description": "String inside a set!"
-										}
 									}
 								]
 							},

internal/cmd/testdata/github/generator_config.yml

@@ -23,6 +23,17 @@ resources:
           repo: name
 
 data_sources:
+  gists:
+    read:
+      path: /gists/{gist_id}
+      method: GET
+    schema:
+      ignores:
+        - fork_of.forks
+        - fork_of.history
+        - fork_of.files.language
+        - forks.user.plan.collaborators
+
   repository:
     read:
       path: /repos/{owner}/{repo}