Skip to content

Commit ab16562

Browse files
committed
Copilot edits
1 parent 1b13d76 commit ab16562

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

api-playground/customization/adding-sdk-examples.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Display language-specific code samples alongside your API endpoint
55

66
If your users interact with your API using an SDK rather than directly through a network request, you can use the `x-codeSamples` extension to add code samples to your OpenAPI document and Mintlify will display them in your OpenAPI pages.
77

8-
This property can be added within any request method and has the following schema.
8+
This property can be added to any request method and has the following schema.
99

1010
<ParamField body="lang" type="string" required>
1111
The language of the code sample.

api-playground/customization/complex-data-types.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ When your API accepts multiple data formats, has conditional fields, or uses inh
99

1010
For complex data types, OpenAPI provides keywords for combining schemas:
1111

12-
- `allOf`: Combines multiple schemas (like merging objects or extending a base schema). Functions like an "and" operator.
13-
- `anyOf`: Accepts data matching any of the provided schemas. Functions like an "or" operator.
14-
- `oneOf`: Accepts data matching exactly one of the provided schemas. Functions like an "exclusive-or" operator.
12+
- `allOf`: Combines multiple schemas (like merging objects or extending a base schema). Functions like an *and* operator.
13+
- `anyOf`: Accepts data matching any of the provided schemas. Functions like an *or* operator.
14+
- `oneOf`: Accepts data matching exactly one of the provided schemas. Functions like an *exclusive-or* operator.
1515

1616
<Warning>Mintlify treats `oneOf` and `anyOf` identically. Most APIs work fine with `anyOf` since the practical difference is rarely important to users.</Warning>
1717

@@ -56,7 +56,7 @@ components:
5656
5757
### Providing options with `oneOf` and `anyOf`
5858

59-
When you use `oneOf` or `anyOf`, Mintlify displays the options in a tabbed container. To give your options helpful names, specify a `title` field in each subschema. For example, here's how you might display two different types of delivery addresses:
59+
When you use `oneOf` or `anyOf`, Mintlify displays the options in a tabbed container. Specify a `title` field in each subschema to give your options names. For example, here's how you might display two different types of delivery addresses:
6060

6161
```yaml
6262
delivery_address:

api-playground/customization/managing-page-visibility.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ If your pages are autogenerated from an OpenAPI document, you can control which
1010

1111
## `x-hidden`
1212

13-
The `x-hidden` extension creates a page for an endpoint, but hides it from navigation. The page is only accessible by navigating directly its URL.
13+
The `x-hidden` extension creates a page for an endpoint, but hides it from navigation. The page is only accessible by navigating directly to its URL.
1414

1515
Common use cases for `x-hidden` are:
1616

api-playground/mdx/configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ authMethod: "key"
153153

154154
### None
155155

156-
The "none" authentication method is useful to disable authentication on a specific endpoint after setting a default in docs.json.
156+
The `none` authentication method is useful to disable authentication on a specific endpoint after setting a default in docs.json.
157157

158158
<CodeGroup>
159159
```md Page Metadata

api-playground/openapi-setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ To document your endpoints with OpenAPI, you need a valid OpenAPI document in ei
1212

1313
### Describing your API
1414

15-
We reccomend the following resources to learn about and construct your OpenAPI documents.
15+
We recommend the following resources to learn about and construct your OpenAPI documents.
1616

1717
- [Swagger's OpenAPI Guide](https://swagger.io/docs/specification/v3_0/basic-structure/) to learn the OpenAPI syntax.
1818
- [OpenAPI v3.1.0 Specification](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md) to reference details of the newest OpenAPI specification.

0 commit comments

Comments
 (0)