Skip to content

Commit 2472ba3

Browse files
Merge branch 'main' into pkar/async-include-ccs-metadata
2 parents fb5c06a + 0efbba5 commit 2472ba3

File tree

19 files changed

+1301
-359
lines changed

19 files changed

+1301
-359
lines changed

Makefile

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ setup: ## Install dependencies for contrib target
3939
@make clean-dep
4040
@npm install --prefix compiler
4141
@npm install --prefix typescript-generator
42-
@npm install @stoplight/spectral-cli
42+
@npm install @redocly/cli
4343

4444
clean-dep: ## Clean npm dependencies
4545
@rm -rf compiler/node_modules
@@ -68,15 +68,15 @@ overlay-docs: ## Apply overlays to OpenAPI documents
6868
rm output/openapi/elasticsearch-openapi.tmp*.json
6969

7070
lint-docs: ## Lint the OpenAPI documents after overlays
71-
@npx @stoplight/spectral-cli lint output/openapi/elasticsearch-*.examples.json --ruleset .spectral.yaml
71+
@npx @redocly/cli lint "output/openapi/elasticsearch-*.json" --config "docs/linters/redocly.yaml" --format stylish --max-problems 500
7272

73-
lint-docs-errs: ## Lint the OpenAPI documents after overlays and return only errors
74-
@npx @stoplight/spectral-cli lint output/openapi/elasticsearch-*.examples.json --ruleset .spectral.yaml -D
73+
lint-docs-stateful: ## Lint only the elasticsearch-openapi.examples.json file
74+
@npx @redocly/cli lint "output/openapi/elasticsearch-openapi.examples.json" --config "docs/linters/redocly.yaml" --format stylish --max-problems 500
7575

7676
lint-docs-serverless: ## Lint only the serverless OpenAPI document after overlays
77-
@npx @stoplight/spectral-cli lint output/openapi/elasticsearch-serverless-openapi.examples.json --ruleset .spectral.yaml
77+
@npx @redocly/cli lint "output/openapi/elasticsearch-serverless-openapi.examples.json" --config "docs/linters/redocly.yaml" --format stylish --max-problems 500
7878

79-
contrib: | generate license-check spec-format-fix transform-to-openapi filter-for-serverless lint-docs-errs ## Pre contribution target
79+
contrib: | generate license-check spec-format-fix transform-to-openapi filter-for-serverless lint-docs ## Pre contribution target
8080

8181
help: ## Display help
8282
@awk 'BEGIN {FS = ":.*##"; printf "Usage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ to install and configure Node.js in your development environment.
2727
You can install Node.js with [`nvm`](https://github.com/nvm-sh/nvm):
2828

2929
```sh
30-
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
30+
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
3131
```
3232

3333
Once the installation is completed, install Node.js with `nvm`:

compiler-rs/clients_schema_to_openapi/package-lock.json

Lines changed: 35 additions & 32 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
File renamed without changes.

docs/linters/redocly.yaml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
extends:
2+
- recommended
3+
rules:
4+
# Built-in rules
5+
# Descriptions
6+
parameter-description: warn
7+
tag-description: warn
8+
operation-description: off
9+
# Document info
10+
info-contact: warn
11+
info-license: warn
12+
no-empty-servers: warn
13+
# Examples
14+
no-invalid-media-type-examples:
15+
severity: off
16+
allowAdditionalProperties: false
17+
no-invalid-schema-examples:
18+
severity: warn
19+
allowAdditionalProperties: false
20+
# Operations
21+
operation-operationId: error
22+
operation-operationId-unique: error
23+
operation-operationId-url-safe: warn
24+
operation-summary: warn
25+
# Parameters
26+
path-parameters-defined: warn
27+
# Paths
28+
no-ambiguous-paths: off
29+
no-identical-paths: warn
30+
path-excludes-patterns:
31+
severity: error
32+
patterns:
33+
- ^\/internal
34+
# Responses
35+
operation-4xx-response: off
36+
operation-2xx-response: off
37+
# Schema
38+
struct: error
39+
spec-components-invalid-map-name: off
40+
spec-strict-refs: off
41+
security-defined: off
42+
# Tags
43+
operation-tag-defined: off
44+
tags-alphabetical: off
45+
operation-singular-tag: off
46+
# Custom rules
47+
rule/operation-summary-length:
48+
subject:
49+
type: Operation
50+
property: summary
51+
message: Operation summary must have a minimum of 5 and maximum of 45 characters
52+
severity: warn
53+
assertions:
54+
maxLength: 45
55+
minLength: 5

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,11 @@ actions:
3333
description: >
3434
The connector and sync jobs APIs provide a convenient way to create and manage Elastic connectors and sync jobs in an internal index.
3535
36-
Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure:
37-
38-
* Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud
39-
40-
* Self-managed connectors (Connector clients) are self-managed on your infrastructure.
41-
36+
Connectors are Elasticsearch integrations for syncing content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.
4237
4338
This API provides an alternative to relying solely on Kibana UI for connector and sync job management. The API comes with a set of validations and assertions to ensure that the state representation in the internal index remains valid.
39+
40+
This API requires the `manage_connector` privilege or, for read-only endpoints, the `monitor_connector` privilege.
4441
externalDocs:
4542
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/es-connectors-tutorial-api.html
4643
description: Check out the connector API tutorial

0 commit comments

Comments
 (0)