Enhance pings documentation (within swaggers) / add to clients#138
Open
skelz0r wants to merge 4 commits into
Open
Enhance pings documentation (within swaggers) / add to clients#138skelz0r wants to merge 4 commits into
skelz0r wants to merge 4 commits into
Conversation
…rticulierv2) Add rswag specs for all ping routes: global ping, provider pings list, and individual provider ping. These endpoints are unauthenticated (security: []) and grouped under the new "Disponibilité" tag. Adapt the swagger generation pipeline to handle unauthenticated endpoints: - ErrorInjector skips error injection for security: [] operations - augment_openapi_files skips maintenances/code samples for security: [] - spec_helper x-operationId hook guards against controllers without operation_id (PingController inherits ApplicationController, not ApiController), checking both protected and private visibility
The ping endpoints added to the OpenAPI specs use `security: []` (no auth required). The scaffold scripts were picking them up as a new "ping" provider, which is incorrect — they are monitoring endpoints, not data provider resources for the SDK. Both Ruby and Node scaffold scripts now skip operations with an empty security array, keeping the generated client code unchanged.
Both APIs expose unauthenticated monitoring endpoints (security: [] in OpenAPI): ping, pings, and ping_provider. These were not surfaced in the SDK clients. Changes: - Add get_public/getPublic to ClientBase (skips auth + audit param validation, keeps User-Agent, timeouts, logging, error mapping) - Add ping(), pings(), ping_provider() directly on each Client class (not via scaffold, since these aren't data-provider resources) - Sync vendored commons to both Ruby gems and Node packages - Add tests verifying no Authorization header is sent - Document public endpoints in SPECS.md §9.5 and conformance checklist
The ping endpoints (security: []) have no x-operationId, no response schema, no provider, and no test case entry — by design, since they are public monitoring endpoints, not data-provider resources. Skip paths with security: [] in the 4 specs that iterate over all swagger paths: open_api_validation, open_api_schema_to_example, endpoints_with_test_case, and extract_provider_from_path.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.