user_schemas

Creates, updates, deletes, gets or lists a user_schemas resource.

Overview

Name	user_schemas
Type	Resource
Id	cloudflare.api_gateway.user_schemas

Fields

The following fields are returned by SELECT queries:

get

Retrieve information about a specific schema on a zone response

Name	Datatype	Description
name	string	Name of the schema (example: petstore schema)
schema_id	string	UUID. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
kind	string	Kind of schema (openapi_v3) (example: openapi_v3)
source	string	Source of the schema (example: <schema file bytes>)
validation_enabled	boolean	Flag whether schema is enabled for validation.

list

Retrieve information about all schemas on a zone response

Name	Datatype	Description
name	string	Name of the schema (example: petstore schema)
schema_id	string	UUID. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
kind	string	Kind of schema (openapi_v3) (example: openapi_v3)
source	string	Source of the schema (example: <schema file bytes>)
validation_enabled	boolean	Flag whether schema is enabled for validation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	zone_id, schema_id	omit_source	Gets detailed information about a specific uploaded OpenAPI schema, including its contents and validation configuration.
list	select	zone_id	page, per_page, omit_source, validation_enabled	Lists all OpenAPI schemas uploaded to API Shield for the zone, including their validation status and associated operations.
create	insert	zone_id, file, kind
edit	update	zone_id, schema_id		Activates schema validation for an uploaded OpenAPI schema. Requests to matching endpoints will be validated against the schema definitions.
delete	delete	zone_id, schema_id		Permanently removes an uploaded OpenAPI schema from API Shield schema validation. Operations using this schema will lose their validation rules.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
schema_id	string (uuid)	Identifier for the schema-ID
zone_id	string	The Cloudflare zone ID.
omit_source	boolean	Omit the source-files of schemas and only retrieve their meta-data.
page	integer	Page number of paginated results.
per_page	integer	Maximum number of results per page.
validation_enabled	boolean

SELECT examples

get

Gets detailed information about a specific uploaded OpenAPI schema, including its contents and validation configuration.

SELECT
name,
schema_id,
created_at,
kind,
source,
validation_enabled
FROM cloudflare.api_gateway.user_schemas
WHERE zone_id = '{{ zone_id }}' -- required
AND schema_id = '{{ schema_id }}' -- required
AND omit_source = '{{ omit_source }}'
;

list

Lists all OpenAPI schemas uploaded to API Shield for the zone, including their validation status and associated operations.

SELECT
name,
schema_id,
created_at,
kind,
source,
validation_enabled
FROM cloudflare.api_gateway.user_schemas
WHERE zone_id = '{{ zone_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND omit_source = '{{ omit_source }}'
AND validation_enabled = '{{ validation_enabled }}'
;

INSERT examples

create

No description available.

INSERT INTO cloudflare.api_gateway.user_schemas (
file,
kind,
name,
validation_enabled,
zone_id
)
SELECT 
'{{ file }}' /* required */,
'{{ kind }}' /* required */,
'{{ name }}',
'{{ validation_enabled }}',
'{{ zone_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: user_schemas
props:
  - name: zone_id
    value: "{{ zone_id }}"
    description: Required parameter for the user_schemas resource.
  - name: file
    value: "{{ file }}"
    description: |
      Schema file bytes
  - name: kind
    value: "{{ kind }}"
    description: |
      Kind of schema
    valid_values: ['openapi_v3']
  - name: name
    value: "{{ name }}"
    description: |
      Name of the schema
  - name: validation_enabled
    value: "{{ validation_enabled }}"
    description: |
      Flag whether schema is enabled for validation.
    valid_values: ['true', 'false']

UPDATE examples

edit

Activates schema validation for an uploaded OpenAPI schema. Requests to matching endpoints will be validated against the schema definitions.

UPDATE cloudflare.api_gateway.user_schemas
SET 
validation_enabled = {{ validation_enabled }}
WHERE 
zone_id = '{{ zone_id }}' --required
AND schema_id = '{{ schema_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Permanently removes an uploaded OpenAPI schema from API Shield schema validation. Operations using this schema will lose their validation rules.

DELETE FROM cloudflare.api_gateway.user_schemas
WHERE zone_id = '{{ zone_id }}' --required
AND schema_id = '{{ schema_id }}' --required
;