Skip to content

Commit

Permalink
Merge branch 'main' into rollover-etc-summaries
Browse files Browse the repository at this point in the history
  • Loading branch information
shainaraskas authored Jul 26, 2024
2 parents 52a517b + 4b67d9a commit d00b520
Show file tree
Hide file tree
Showing 29 changed files with 1,554 additions and 934 deletions.
6 changes: 3 additions & 3 deletions .spectral.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ rules:
oas3-valid-schema-example: false
oas2-valid-media-example: false
# Operations
operation-operationId: false
operation-operationId-unique: false
operation-operationId-valid-in-url: false
operation-operationId: warn
operation-operationId-unique: warn
operation-operationId-valid-in-url: warn
operation-tag-defined: warn
operation-tags: warn
# Responses
Expand Down
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ dump-routes: ## Create a new schema with all generics expanded

contrib: | generate license-check spec-format-fix transform-to-openapi filter-for-serverless ## Pre contribution target

overlay-docs: ## Apply overlays to OpenAPI documents
@npx bump overlay "output/openapi/elasticsearch-serverless-openapi.json" "docs/overlays/elasticsearch-serverless-openapi-overlays.yaml" > "output/openapi/elasticsearch-serverless-openapi.new.json"

lint-docs: ## Lint the OpenAPI documents
@npx @stoplight/spectral-cli lint output/openapi/*.json --ruleset .spectral.yaml

Expand Down
15 changes: 15 additions & 0 deletions docs/overlays/elasticsearch-serverless-openapi-overlays.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# overlays.yaml
overlay: 1.0.0
info:
title: Overlays for the Elasticsearch Serverless OpenAPI document
version: 0.0.1
actions:
- target: '$.info'
description: Add a document description
update:
description: >
**Technical preview**
This functionality is in technical preview and may be changed or removed in a future release.
Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
Loading

0 comments on commit d00b520

Please sign in to comment.