Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions registries/_extension/x-jsonschema-contentSchema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
owner: baywet
issue:
description: The JSON Schema contentSchema subschema for decoded string content, used when targeting OpenAPI versions that do not directly support it.
schema:
$ref: "#/$defs/schemaObject"
objects: [ "Schema Object" ]
layout: default
---

{% capture summary %}
JSON Schema defines the `contentSchema` keyword to describe the schema for decoded string content.

The `x-jsonschema-contentSchema` extension mirrors this JSON Schema keyword when targeting OpenAPI versions where the keyword is not directly available, serializing it as `x-jsonschema-contentSchema`.

It can appear as a property in the following objects: `{{page.objects|jsonify}}`.

Used by: (informational)

* [Microsoft.OpenApi](https://github.com/microsoft/OpenAPI.NET) (.NET OpenAPI library)
{% endcapture %}

{% capture example %}
```yaml
openapi: 3.0.4
info:
title: My API
version: 1.0.0
paths: {}
components:
schemas:
EncodedPayload:
type: string
x-jsonschema-contentEncoding: base64
x-jsonschema-contentMediaType: application/json
x-jsonschema-contentSchema:
type: object
required:
- id
properties:
id:
type: string
```
{% endcapture %}

{% include extension-entry.md summary=summary example=example %}