Skip to content

Commit 8509ea3

Browse files
committed
fix(api-ref): Update getswagger.sh destination paths to use the new directory structure when fetching spec files. Update the redocly plugin module path.
1 parent f1d82f4 commit 8509ea3

File tree

7 files changed

+34
-29
lines changed

7 files changed

+34
-29
lines changed

api-docs/.config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
plugins:
2-
- './openapi/plugins/docs-plugin.js'
2+
- './../openapi/plugins/docs-plugin.js'
33
extends:
44
- recommended
55
- docs/all

api-docs/getswagger.sh

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -139,93 +139,98 @@ function postProcess() {
139139
}
140140

141141
function updateCloudV2 {
142-
outFile="cloud/v2/ref.yml"
142+
outFile="influxdb/cloud/v2/ref.yml"
143143
if [[ -z "$baseUrl" ]];
144144
then
145145
echo "Using existing $outFile"
146146
else
147147
curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile
148148
fi
149-
postProcess $outFile 'cloud/.config.yml' v2@2
149+
postProcess $outFile 'influxdb/cloud/.config.yml' v2@2
150150
}
151151

152152
function updateCloudDedicatedManagement {
153-
outFile="cloud-dedicated/management/openapi.yml"
153+
outFile="influxdb3/cloud-dedicated/management/openapi.yml"
154154
if [[ -z "$baseUrl" ]];
155155
then
156156
echo "Using existing $outFile"
157157
else
158-
curl $UPDATE_OPTIONS https://raw.githubusercontent.com/influxdata/granite/ab7ee2aceacfae7f415d15ffbcf8c9d0f6f3e015/openapi.yaml -o $outFile
158+
# Clone influxdata/granite and fetch the latest openapi.yaml file.
159+
echo "Fetching the latest openapi.yaml file from influxdata/granite"
160+
tmp_dir=$(mktemp -d)
161+
git clone --depth 1 --branch main https://github.com/influxdata/granite.git "$tmp_dir"
162+
cp "$tmp_dir/openapi.yaml" "$outFile"
163+
rm -rf "$tmp_dir"
159164
fi
160-
postProcess $outFile 'cloud-dedicated/.config.yml' management@0
165+
postProcess $outFile 'influxdb3/cloud-dedicated/.config.yml' management@0
161166
}
162167

163168
function updateCloudDedicatedV2 {
164-
outFile="cloud-dedicated/v2/ref.yml"
169+
outFile="influxdb3/cloud-dedicated/v2/ref.yml"
165170
if [[ -z "$baseUrl" ]];
166171
then
167172
echo "Using existing $outFile"
168173
else
169174
curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile
170175
fi
171-
postProcess $outFile 'cloud-dedicated/.config.yml' v2@2
176+
postProcess $outFile 'influxdb3/cloud-dedicated/.config.yml' v2@2
172177
}
173178

174179
function updateClusteredV2 {
175-
outFile="clustered/v2/ref.yml"
180+
outFile="influxdb3/clustered/v2/ref.yml"
176181
if [[ -z "$baseUrl" ]];
177182
then
178183
echo "Using existing $outFile"
179184
else
180185
curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile
181186
fi
182-
postProcess $outFile 'clustered/.config.yml' v2@2
187+
postProcess $outFile 'influxdb3/clustered/.config.yml' v2@2
183188
}
184189

185190
function updateCloudServerlessV2 {
186-
outFile="cloud-serverless/v2/ref.yml"
191+
outFile="influxdb3/cloud-serverless/v2/ref.yml"
187192
if [[ -z "$baseUrl" ]];
188193
then
189194
echo "Using existing $outFile"
190195
else
191196
curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile
192197
fi
193-
postProcess $outFile 'cloud-serverless/.config.yml' v2@2
198+
postProcess $outFile 'influxdb3/cloud-serverless/.config.yml' v2@2
194199
}
195200

196201
function updateOSSV2 {
197-
outFile="v2/ref.yml"
202+
outFile="influxdb/v2/ref.yml"
198203
if [[ -z "$baseUrlOSS" ]];
199204
then
200205
echo "Using existing $outFile"
201206
else
202207
curl $UPDATE_OPTIONS ${baseUrlOSS}/contracts/ref/oss.yml -o $outFile
203208
fi
204-
postProcess $outFile 'v2/.config.yml' '@2'
209+
postProcess $outFile 'influxdb/v2/.config.yml' '@2'
205210
}
206211

207212
function updateV1Compat {
208-
outFile="cloud/v1-compatibility/swaggerV1Compat.yml"
213+
outFile="influxdb/cloud/v1-compatibility/swaggerV1Compat.yml"
209214
if [[ -z "$baseUrl" ]];
210215
then
211216
echo "Using existing $outFile"
212217
else
213218
curl $UPDATE_OPTIONS ${baseUrl}/contracts/swaggerV1Compat.yml -o $outFile
214219
fi
215-
postProcess $outFile 'cloud/.config.yml' 'v1-compatibility'
220+
postProcess $outFile 'influxdb/cloud/.config.yml' 'v1-compatibility'
216221

217-
outFile="v2/v1-compatibility/swaggerV1Compat.yml"
222+
outFile="influxdb/v2/v1-compatibility/swaggerV1Compat.yml"
218223
cp cloud/v1-compatibility/swaggerV1Compat.yml $outFile
219-
postProcess $outFile 'v2/.config.yml' 'v1-compatibility'
224+
postProcess $outFile 'influxdb/v2/.config.yml' 'v1-compatibility'
220225

221-
outFile="cloud-dedicated/v1-compatibility/swaggerV1Compat.yml"
222-
postProcess $outFile 'cloud-dedicated/.config.yml' 'v1-compatibility'
226+
outFile="influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml"
227+
postProcess $outFile 'influxdb3/cloud-dedicated/.config.yml' 'v1-compatibility'
223228

224-
outFile="cloud-serverless/v1-compatibility/swaggerV1Compat.yml"
225-
postProcess $outFile 'cloud-serverless/.config.yml' 'v1-compatibility'
229+
outFile="influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml"
230+
postProcess $outFile 'influxdb3/cloud-serverless/.config.yml' 'v1-compatibility'
226231

227-
outFile="clustered/v1-compatibility/swaggerV1Compat.yml"
228-
postProcess $outFile 'clustered/.config.yml' 'v1-compatibility'
232+
outFile="influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml"
233+
postProcess $outFile 'influxdb3/clustered/.config.yml' 'v1-compatibility'
229234
}
230235

231236
UPDATE_OPTIONS="--fail"

api-docs/influxdb/cloud/.config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
plugins:
2-
- '../openapi/plugins/docs-plugin.js'
2+
- '../../openapi/plugins/docs-plugin.js'
33
extends:
44
- recommended
55
- docs/all

api-docs/influxdb/v2/.config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
plugins:
2-
- '../openapi/plugins/docs-plugin.js'
2+
- '../../openapi/plugins/docs-plugin.js'
33
extends:
44
- recommended
55
- docs/all

api-docs/influxdb3/cloud-dedicated/.config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
plugins:
2-
- '../openapi/plugins/docs-plugin.js'
2+
- '../../openapi/plugins/docs-plugin.js'
33
extends:
44
- recommended
55
- docs/all

api-docs/influxdb3/cloud-serverless/.config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
plugins:
2-
- '../openapi/plugins/docs-plugin.js'
2+
- '../../openapi/plugins/docs-plugin.js'
33
extends:
44
- recommended
55
- docs/all

api-docs/influxdb3/clustered/.config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
plugins:
2-
- '../openapi/plugins/docs-plugin.js'
2+
- '../../openapi/plugins/docs-plugin.js'
33
extends:
44
- recommended
55
- docs/all

0 commit comments

Comments
 (0)