From b0b0af036b94b471249e1d39ab8cf08ee0e33fec Mon Sep 17 00:00:00 2001 From: AmandaYao00 Date: Mon, 15 Jun 2026 09:54:18 -0700 Subject: [PATCH] sampling endopint docs --- api/api.yaml | 34 +++- api/generated/api.json | 346 ++++++++++++++++++++++++++++++++++++++++- 2 files changed, 378 insertions(+), 2 deletions(-) diff --git a/api/api.yaml b/api/api.yaml index 185af79..5780819 100644 --- a/api/api.yaml +++ b/api/api.yaml @@ -1077,6 +1077,16 @@ paths: schema: type: string example: "113e9685-9a51-42cc-8662-9d9725b17f14" + - name: skipSampling + in: query + required: false + description: + When `true`, skips the sample read that validates the installation's + read configuration against the provider before saving. Defaults to + `false`. + schema: + type: boolean + default: false requestBody: content: application/json: @@ -1173,7 +1183,10 @@ paths: schema: $ref: "../problem/problem.yaml#/components/schemas/InputValidationProblem" 422: - description: Unprocessable Entity + description: + Unprocessable Entity. Returned when the config is invalid, or when the + sample read fails because a selected field or mapping is not visible to + the connected user. content: application/problem+json: schema: @@ -1341,6 +1354,16 @@ paths: schema: type: string example: 7b3c9d2e-5a1f-4e8b-b6d4-9c8a2f1e5d3b + - name: skipSampling + in: query + required: false + description: + When `true`, skips the sample read that validates the installation's + read configuration against the provider before saving. Defaults to + `false`. + schema: + type: boolean + default: false requestBody: content: application/json: @@ -1423,6 +1446,15 @@ paths: application/problem+json: schema: $ref: "../problem/problem.yaml#/components/schemas/InputValidationProblem" + 422: + description: + Unprocessable Entity. Returned when the config is invalid, or when the + sample read fails because a selected field or mapping is not visible to + the connected user. + content: + application/problem+json: + schema: + $ref: "../problem/problem.yaml#/components/schemas/InputValidationProblem" default: description: Error content: diff --git a/api/generated/api.json b/api/generated/api.json index 08257a8..56ba5c2 100644 --- a/api/generated/api.json +++ b/api/generated/api.json @@ -14824,6 +14824,16 @@ "type": "string" }, "example": "113e9685-9a51-42cc-8662-9d9725b17f14" + }, + { + "name": "skipSampling", + "in": "query", + "required": false, + "description": "When `true`, skips the sample read that validates the installation's read configuration against the provider before saving. Defaults to `false`.", + "schema": { + "type": "boolean", + "default": false + } } ], "requestBody": { @@ -18900,7 +18910,7 @@ } }, "422": { - "description": "Unprocessable Entity", + "description": "Unprocessable Entity. Returned when the config is invalid, or when the sample read fails because a selected field or mapping is not visible to the connected user.", "content": { "application/problem+json": { "schema": { @@ -22197,6 +22207,16 @@ "type": "string" }, "example": "7b3c9d2e-5a1f-4e8b-b6d4-9c8a2f1e5d3b" + }, + { + "name": "skipSampling", + "in": "query", + "required": false, + "description": "When `true`, skips the sample read that validates the installation's read configuration against the provider before saving. Defaults to `false`.", + "schema": { + "type": "boolean", + "default": false + } } ], "requestBody": { @@ -25235,6 +25255,330 @@ } } }, + "422": { + "description": "Unprocessable Entity. Returned when the config is invalid, or when the sample read fails because a selected field or mapping is not visible to the connected user.", + "content": { + "application/problem+json": { + "schema": { + "title": "Input Validation Problem", + "type": "object", + "allOf": [ + { + "title": "API Problem", + "type": "object", + "allOf": [ + { + "title": "Problem", + "description": "A Problem Details object (RFC 9457).\n\nAdditional properties specific to the problem type may be present.\n", + "type": "object", + "properties": { + "type": { + "type": "string", + "format": "uri", + "description": "An absolute URI that identifies the problem type", + "default": "about:blank" + }, + "href": { + "type": "string", + "format": "uri", + "description": "An absolute URI that, when dereferenced, provides human-readable documentation for the problem type (e.g. using HTML)." + }, + "title": { + "type": "string", + "description": "A short summary of the problem type. Written in English and readable for engineers (usually not suited for non technical stakeholders and not localized).", + "example": "Service Unavailable" + }, + "status": { + "type": "integer", + "format": "int32", + "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", + "minimum": 400, + "maximum": 600, + "exclusiveMaximum": true, + "example": 503 + }, + "detail": { + "type": "string", + "description": "A human-readable explanation specific to this occurrence of the problem" + }, + "instance": { + "type": "string", + "format": "uri", + "description": "An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced." + } + }, + "example": { + "type": "urn:problem-type:exampleOrganization:exampleProblem", + "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types", + "title": "Description of the type of problem that occurred", + "status": 400, + "detail": "Description of specific occurrence of the problem", + "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000" + } + } + ], + "properties": { + "subsystem": { + "type": "string", + "description": "The subsystem that generated the problem", + "example": "api" + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time the problem occurred, formatted as RFC-3339", + "example": "2024-04-22T18:55:28.456076Z" + }, + "requestId": { + "type": "string", + "description": "A unique identifier for the request, useful for debugging", + "example": "89eb1ffb-2a54-4105-aaae-7bf990f1aa69#87715" + }, + "causes": { + "type": "array", + "items": { + "type": "string", + "description": "A brief description of something which caused the problem", + "example": "database connection failed" + }, + "example": [ + "database connection failed", + "database query failed", + "unable to fetch user" + ], + "description": "A list of problems that caused this problem. This can be used to represent multiple\nroot causes. There is no guaranteed ordering of the causes.\n" + }, + "remedy": { + "type": "string", + "description": "A brief description of how to resolve the problem", + "example": "Shorten your input to be under 100 characters" + }, + "supportEmail": { + "type": "string", + "format": "email", + "description": "An email address to contact for support", + "example": "support@withampersand.com" + }, + "supportPhone": { + "type": "string", + "description": "A phone number to contact for support", + "example": "+1-555-555-5555" + }, + "supportUrl": { + "type": "string", + "format": "uri", + "description": "A URL to contact for support", + "example": "https://withampersand.com/support" + }, + "retryable": { + "type": "boolean", + "description": "Whether the request can be retried", + "example": false + }, + "retryAfter": { + "type": "string", + "format": "date-time", + "description": "A timestamp after which the request can be retried, formatted as RFC-3339", + "example": "2024-04-22T18:55:28.456076Z" + }, + "context": { + "type": "object", + "description": "Additional context for the problem", + "additionalProperties": true, + "example": { + "name": "Rick Sanchez" + } + } + } + } + ], + "properties": { + "issues": { + "type": "array", + "items": { + "title": "Input Validation Issue", + "type": "object", + "description": "An issue detected during input validation.\n", + "allOf": [ + { + "title": "API Problem", + "type": "object", + "allOf": [ + { + "title": "Problem", + "description": "A Problem Details object (RFC 9457).\n\nAdditional properties specific to the problem type may be present.\n", + "type": "object", + "properties": { + "type": { + "type": "string", + "format": "uri", + "description": "An absolute URI that identifies the problem type", + "default": "about:blank" + }, + "href": { + "type": "string", + "format": "uri", + "description": "An absolute URI that, when dereferenced, provides human-readable documentation for the problem type (e.g. using HTML)." + }, + "title": { + "type": "string", + "description": "A short summary of the problem type. Written in English and readable for engineers (usually not suited for non technical stakeholders and not localized).", + "example": "Service Unavailable" + }, + "status": { + "type": "integer", + "format": "int32", + "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", + "minimum": 400, + "maximum": 600, + "exclusiveMaximum": true, + "example": 503 + }, + "detail": { + "type": "string", + "description": "A human-readable explanation specific to this occurrence of the problem" + }, + "instance": { + "type": "string", + "format": "uri", + "description": "An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced." + } + }, + "example": { + "type": "urn:problem-type:exampleOrganization:exampleProblem", + "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types", + "title": "Description of the type of problem that occurred", + "status": 400, + "detail": "Description of specific occurrence of the problem", + "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000" + } + } + ], + "properties": { + "subsystem": { + "type": "string", + "description": "The subsystem that generated the problem", + "example": "api" + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time the problem occurred, formatted as RFC-3339", + "example": "2024-04-22T18:55:28.456076Z" + }, + "requestId": { + "type": "string", + "description": "A unique identifier for the request, useful for debugging", + "example": "89eb1ffb-2a54-4105-aaae-7bf990f1aa69#87715" + }, + "causes": { + "type": "array", + "items": { + "type": "string", + "description": "A brief description of something which caused the problem", + "example": "database connection failed" + }, + "example": [ + "database connection failed", + "database query failed", + "unable to fetch user" + ], + "description": "A list of problems that caused this problem. This can be used to represent multiple\nroot causes. There is no guaranteed ordering of the causes.\n" + }, + "remedy": { + "type": "string", + "description": "A brief description of how to resolve the problem", + "example": "Shorten your input to be under 100 characters" + }, + "supportEmail": { + "type": "string", + "format": "email", + "description": "An email address to contact for support", + "example": "support@withampersand.com" + }, + "supportPhone": { + "type": "string", + "description": "A phone number to contact for support", + "example": "+1-555-555-5555" + }, + "supportUrl": { + "type": "string", + "format": "uri", + "description": "A URL to contact for support", + "example": "https://withampersand.com/support" + }, + "retryable": { + "type": "boolean", + "description": "Whether the request can be retried", + "example": false + }, + "retryAfter": { + "type": "string", + "format": "date-time", + "description": "A timestamp after which the request can be retried, formatted as RFC-3339", + "example": "2024-04-22T18:55:28.456076Z" + }, + "context": { + "type": "object", + "description": "Additional context for the problem", + "additionalProperties": true, + "example": { + "name": "Rick Sanchez" + } + } + } + } + ], + "properties": { + "in": { + "type": "string", + "description": "The location of the invalid input", + "enum": [ + "body", + "header", + "path", + "query" + ] + }, + "name": { + "type": "string", + "description": "The name of the invalid input" + }, + "value": { + "description": "The value of the erroneous input" + } + } + } + } + }, + "example": { + "type": "about:blank", + "title": "Bad Request", + "status": 400, + "detail": "The input message is incorrect", + "instance": "123456-1234-1235-4567489798", + "issues": [ + { + "type": "about:blank", + "detail": "exampleNumericProperty should be numeric", + "in": "path", + "name": "exampleNumericProperty", + "value": "abc" + }, + { + "type": "about:blank", + "title": "Input isn't valid with respect to schema", + "detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'", + "in": "body", + "name": "items[0].examplePropertyWithPattern", + "value": "a2345678901" + } + ] + } + } + } + } + }, "default": { "description": "Error", "content": {