Skip to content

Commit

Permalink
docs: rename OpenAPI to JSON Schema (#4020)
Browse files Browse the repository at this point in the history
Change-Id: I4d1dc3acdd1bd55ad94a12b441a44f087b2fc98f
  • Loading branch information
jd authored Apr 15, 2024
1 parent c590885 commit 864ab56
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .mergify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ queue_rules:
- or:
- and:
- author=mergify-ci-bot
- head~=^openapi-spec-sync$
- head~=^configuration-spec-sync$
- "title~=^chore: sync"
- and:
- author=mergify-ci-bot
Expand Down
2 changes: 1 addition & 1 deletion plugins/remark-algolia.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { visit } from 'unist-util-visit';
import configSchema from '../public/mergify-configuration-openapi.json';
import configSchema from '../public/mergify-configuration-schema.json';
import { toString } from 'hast-util-to-string';
import algoliasearch from 'algoliasearch';
import type * as unified from 'unified';
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion src/components/Tables/ActionOptionsTable.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import configSchema from '../../../public/mergify-configuration-openapi.json';
import configSchema from '../../../public/mergify-configuration-schema.json';

import { OptionDefinition } from './ConfigOptions';
import { OptionsTableBase } from './OptionsTable';
Expand Down
2 changes: 1 addition & 1 deletion src/components/Tables/ConfigOptions.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React from 'react';
import configSchema from '../../../public/mergify-configuration-openapi.json';
import configSchema from '../../../public/mergify-configuration-schema.json';
import { renderMarkdown } from './utils';

// FIXME: move this to JSON schema?
Expand Down
2 changes: 1 addition & 1 deletion src/components/Tables/OptionsTable.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as yaml from 'js-yaml';

import configSchema from '../../../public/mergify-configuration-openapi.json';
import configSchema from '../../../public/mergify-configuration-schema.json';

import { getValueType, OptionDefinition } from './ConfigOptions';
import { renderMarkdown } from './utils';
Expand Down
2 changes: 1 addition & 1 deletion src/components/Tables/PullRequestAttributes.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import configSchema from '../../../public/mergify-configuration-openapi.json';
import configSchema from '../../../public/mergify-configuration-schema.json';
import { getValueType } from './ConfigOptions';

import { renderMarkdown } from './utils';
Expand Down
8 changes: 4 additions & 4 deletions src/content/docs/configuration/file-format.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -155,16 +155,16 @@ Configuration Files](/configuration/sharing#extending-configuration-files).

{/* <OptionsTable name="Extend" /> */}

## OpenAPI Specification
## JSON Schema Specification

For those interested in a more detailed and machine-readable description of the
Mergify configuration file format, an [OpenAPI](https://www.openapis.org/)
Mergify configuration file format, a [JSON Schema](https://json-schema.org/)
specification is available. This specification can help you understand the
structure of the configuration file and can be used to generate client
libraries, server stubs, or API documentation.

You can find <DownloadLink href="/mergify-configuration-openapi.json">the
OpenAPI specification for the Mergify configuration here</DownloadLink>.
You can find <DownloadLink href="/mergify-configuration-schema.json">the JSON
Schema specification for the Mergify configuration here</DownloadLink>.

## Validation and Troubleshooting

Expand Down

0 comments on commit 864ab56

Please sign in to comment.