Skip to content

Commit 7a11cff

Browse files
authored
Remove generated docs and spec (#715)
* Remove generated docs and spec * remove links to versioned README
1 parent b88b4d7 commit 7a11cff

File tree

2,446 files changed

+3965
-100558
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,446 files changed

+3965
-100558
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ Gemfile.lock
44
failed.txt
55
rerun.txt
66
coverage/
7-
examples/
87
datadog_api_client-*.gem
98
vendor/
109
.generator/lib

Makefile

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
11
.PHONY: all
22
all: .generator .env
3-
@rm -rf ./lib/v1 ./lib/v2 ./spec/v1/api ./spec/v1/models ./spec/v2/api ./spec/v2/models
3+
@rm -rf ./lib/v1 ./lib/v2 ./examples/generated
44
@pre-commit run --all-files --hook-stage=manual openapi-generator || true
5-
@mkdir -p docs/v1 docs/v2 spec/v1 spec/v2
5+
@mkdir -p spec/v1 spec/v2 examples/generated/v1 examples/generated/v2
66
@cp -R v1/lib/datadog_api_client ./lib/
77
@cp -R v2/lib/datadog_api_client ./lib/
88
@rm lib/datadog_api_client/v*/version.rb
9-
@cp -nR v1/spec/*_spec.rb v1/spec/api v1/spec/models ./spec/v1/ || true
10-
@cp -nR v2/spec/*_spec.rb v2/spec/api v2/spec/models ./spec/v2/ || true
11-
@cp -R v1/docs/* ./docs/v1/
12-
@cp -R v2/docs/* ./docs/v2/
13-
@cp v1/README.md ./docs/v1/
14-
@cp v2/README.md ./docs/v2/
9+
@ls v1/docs/*API.md | grep -v IPPrefixesAPI.md | xargs -n1 ./extract-code-blocks.awk -v output="examples/generated/v1"
10+
@ls v2/docs/*API.md | grep -v IPPrefixesAPI.md | xargs -n1 ./extract-code-blocks.awk -v output="examples/generated/v2"
1511
@rm -rf v1 v2
1612
@pre-commit run --all-files --hook-stage=manual docs || echo "modified files"
1713

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ config = DatadogAPIClient::V1::Configuration.new
127127
config.compress = false
128128
client = DatadogAPIClient::V1::APIClient.new(config)
129129
```
130-
130+
131131
### Enable requests logging
132132

133133
If you want to enable requests logging, set the `debugging` flag
@@ -143,7 +143,9 @@ client = DatadogAPIClient::V1::APIClient.new(config)
143143

144144
If you are interested in general documentation for all public Datadog API endpoints, checkout the [general documentation site](api docs).
145145

146+
<!-- FIXME create gh-pages with generated documentation
146147
Developer documentation for supported endpoints and models is divided based on API version prefix to [`v1`](/docs/v1/README.md) and [`v2`](/docs/v2/README.md).
148+
-->
147149

148150
For contributing, checkout the [contribution guidelines](contribution docs) and [development guide][development docs].
149151

docs/v1/APIErrorResponse.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/v1/AWSAccount.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

docs/v1/AWSAccountAndLambdaRequest.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/v1/AWSAccountCreateResponse.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/v1/AWSAccountDeleteRequest.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/v1/AWSAccountListResponse.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)