upstream/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2026-02-03 20:39:32 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 13
prometheus/.yamllint

27 lines
507 B
Text
Raw Normal View History

Adds yamllinting to Makefile.common * adds yamllint target to Makefile.common for use by all Prometheus projects Signed-off-by: Michal Wasilewski <mwasilewski@gmx.com>
2021-05-09 15:00:13 -04:00
---
extends: default
Fix yaml file format and clear ci errors Signed-off-by: heyitao <heyitao@uniontech.com>
2024-03-20 23:32:02 -04:00
ignore: |
Update linting (#15369) * Ignore all node_modules dirs. * Update Makefile.common golangci-lint to match CI pipeline. Signed-off-by: SuperQ <superq@gmail.com>
2024-11-12 07:27:39 -05:00
**/node_modules
Add OpenAPI 3.2 specification generation for Prometheus HTTP API (#17825) * Add OpenAPI 3.2 specification generation for Prometheus HTTP API This commit introduces an OpenAPI specification for the Prometheus API. After testing multiple code-generation servers with built-in APIs, this implementation uses an independent spec file outside of the critical path. This spec file is tested with a framework present in this pull request. The specification helps clients know which parameters they can use and is served at /api/v1/openapi.yaml. The spec file will evolve with the Prometheus API and has the same version number. Downstream projects can tune the APIs presented in the spec file with configuration options using the IncludePaths setting for path filtering. In the future, there is room to generate a server from this spec file (e.g. with interfaces), but this is out of scope for this pull request. Architecture: - Core OpenAPI infrastructure (openapi.go): Dynamic spec building, caching, and thread-safe spec generation - Schema definitions (openapi_schemas.go): Complete type definitions for all API request and response types - Path specifications (openapi_paths.go): Endpoint definitions with parameters, request bodies, and response schemas - Examples (openapi_examples.go): Realistic request/response examples - Helper functions (openapi_helpers.go): Reusable builders for common OpenAPI structures Testing: - Comprehensive test suite with golden file validation - Test helpers package for API testing infrastructure - OpenAPI compliance validation utilities The golden file captures the complete specification for snapshot testing. Update with: go test -run TestOpenAPIGolden -update-openapi-spec REVIEWERS: The most important thing to check would be the OpenAPI golden file (web/api/v1/testdata/openapi_golden.yaml). Test scenarios are important as they test the actual OpenAPI spec validity. Signed-off-by: Julien Pivotto <291750+roidelapluie@users.noreply.github.com> * Add OpenAPI 3.1 support with version selection Add support for both OpenAPI 3.1 and 3.2 specifications with version selection via openapi_version query parameter. Defaults to 3.1 for broader compatibility Signed-off-by: Julien Pivotto <291750+roidelapluie@users.noreply.github.com> * Enhance OpenAPI examples and add helper functions - Add timestampExamples helper for consistent time formatting - Add exampleMap helper to simplify example creation - Improve example summaries with query details - Add matrix result example for range vector queries Signed-off-by: Julien Pivotto <291750+roidelapluie@users.noreply.github.com> * web/api: Add AtST method to test helper iterators Implement the AtST() method required by chunkenc.Iterator interface for FakeSeriesIterator and FakeHistogramSeriesIterator test helpers. The method returns 0 as these test helpers don't use start timestamps Signed-off-by: Julien Pivotto <291750+roidelapluie@users.noreply.github.com> * OpenAPI: Add minimum coverage test Signed-off-by: Julien Pivotto <291750+roidelapluie@users.noreply.github.com> * OpenAPI: Improve examples handling Signed-off-by: Julien Pivotto <291750+roidelapluie@users.noreply.github.com> --------- Signed-off-by: Julien Pivotto <291750+roidelapluie@users.noreply.github.com>
2026-01-29 07:36:13 -05:00
web/api/v1/testdata/openapi_*_golden.yaml
Adds yamllinting to Makefile.common * adds yamllint target to Makefile.common for use by all Prometheus projects Signed-off-by: Michal Wasilewski <mwasilewski@gmx.com>
2021-05-09 15:00:13 -04:00
rules:
braces:
max-spaces-inside: 1
level: error
brackets:
max-spaces-inside: 1
level: error
commas: disable
comments: disable
comments-indentation: disable
disable warning about missing document start in yamllint Signed-off-by: Michal Wasilewski <mwasilewski@gmx.com>
2021-06-12 06:48:47 -04:00
document-start: disable
Adds yamllinting to Makefile.common * adds yamllint target to Makefile.common for use by all Prometheus projects Signed-off-by: Michal Wasilewski <mwasilewski@gmx.com>
2021-05-09 15:00:13 -04:00
indentation:
spaces: consistent
Relax yamllint Relax indentation to allow non-indented sequences. This helps with generated yaml linke the snmp_exporter config output. Signed-off-by: SuperQ <superq@gmail.com>
2022-05-06 03:59:59 -04:00
indent-sequences: consistent
ignore duplicate key in a file that is deliberately broken Signed-off-by: Michal Wasilewski <mwasilewski@gmx.com>
2021-06-12 06:53:35 -04:00
key-duplicates:
ignore: |
avoid glob pattern for key-duplicates Signed-off-by: Michal Wasilewski <mwasilewski@gmx.com>
2021-06-12 07:12:47 -04:00
config/testdata/section_key_dup.bad.yml
Adds yamllinting to Makefile.common * adds yamllint target to Makefile.common for use by all Prometheus projects Signed-off-by: Michal Wasilewski <mwasilewski@gmx.com>
2021-05-09 15:00:13 -04:00
line-length: disable
ignore truthy in selected files Signed-off-by: Michal Wasilewski <mwasilewski@gmx.com>
2021-06-12 07:12:00 -04:00
truthy:
yamllint: don’t check keys and add file extension to config file Signed-off-by: Matthieu MOREL <matthieu.morel35@gmail.com> Signed-off-by: Matthieu MOREL <matthieu.morel35@gmail.com>
2023-04-08 04:26:06 -04:00
check-keys: false
Reference in a new issue Copy permalink