Skip to content

fix(api): sync the schemas and retire the badges reference with them #12482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jd wants to merge 1 commit into from
Draft

fix(api): sync the schemas and retire the badges reference with them #12482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions public/_redirects
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@
/api-usage/ /api/usage 301
/api/eventlogs /api/activity-log/ 301
/api/eventlogs/ /api/activity-log/ 301

# The badge API is retired, so /api/badges has no successor page. Send it to
# the reference index rather than 404ing a URL the sidebar linked site-wide.
/api/badges /api/ 301
/api/badges/ /api/ 301

/examples /integrations 301
/examples/ /integrations 301
/examples/_ /integrations/:splat 301
Expand Down
235 changes: 12 additions & 223 deletions public/api-schemas.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -715,213 +715,6 @@
}
}
},
"/badges/{owner}/{repository}.png": {
"get": {
"tags": [
"badges"
],
"summary": "Get PNG badge",
"description": "Get badge in PNG image format",
"operationId": "badge_png_badges__owner___repository__png_get",
"deprecated": true,
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 40,
"pattern": "^[a-zA-Z0-9\\-]+$",
"description": "The owner of the repository",
"title": "Owner"
},
"description": "The owner of the repository"
},
{
"name": "repository",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[\\w\\-\\.]+$",
"description": "The name of the repository",
"title": "Repository"
},
"description": "The name of the repository"
},
{
"name": "style",
"in": "query",
"required": false,
"schema": {
"type": "string",
"description": "The style of the button, more details on https://shields.io/.",
"default": "flat",
"title": "Style"
},
"description": "The style of the button, more details on https://shields.io/."
}
],
"responses": {
"200": {
"description": "An PNG image.",
"content": {
"image/png": {}
}
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"409": {
"description": "Conflict"
},
"422": {
"description": "Unprocessable entity"
}
}
}
},
"/badges/{owner}/{repository}.svg": {
"get": {
"tags": [
"badges"
],
"summary": "Get SVG badge",
"description": "Get badge in SVG image format",
"operationId": "badge_svg_badges__owner___repository__svg_get",
"deprecated": true,
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 40,
"pattern": "^[a-zA-Z0-9\\-]+$",
"description": "The owner of the repository",
"title": "Owner"
},
"description": "The owner of the repository"
},
{
"name": "repository",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[\\w\\-\\.]+$",
"description": "The name of the repository",
"title": "Repository"
},
"description": "The name of the repository"
},
{
"name": "style",
"in": "query",
"required": false,
"schema": {
"type": "string",
"description": "The style of the button, more details on https://shields.io/.",
"default": "flat",
"title": "Style"
},
"description": "The style of the button, more details on https://shields.io/."
}
],
"responses": {
"200": {
"description": "An SVG image.",
"content": {
"image/png": {}
}
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"409": {
"description": "Conflict"
},
"422": {
"description": "Unprocessable entity"
}
}
}
},
"/badges/{owner}/{repository}": {
"get": {
"tags": [
"badges"
],
"summary": "Get shields.io badge config",
"description": "Get shields.io badge JSON configuration",
"operationId": "badge_badges__owner___repository__get",
"deprecated": true,
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 40,
"pattern": "^[a-zA-Z0-9\\-]+$",
"description": "The owner of the repository",
"title": "Owner"
},
"description": "The owner of the repository"
},
{
"name": "repository",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[\\w\\-\\.]+$",
"description": "The name of the repository",
"title": "Repository"
},
"description": "The name of the repository"
}
],
"responses": {
"200": {
"description": "The shields.io badge JSON configuration",
"content": {
"application/json": {}
}
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"409": {
"description": "Conflict"
},
"422": {
"description": "Unprocessable entity"
}
}
}
},
"/repos/{owner}/{repository}/pulls/{number}/simulator": {
"post": {
"tags": [
Expand Down Expand Up @@ -1525,10 +1318,10 @@
"type": "null"
}
],
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages",
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages",
"title": "Cursor"
},
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages"
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages"
},
{
"name": "per_page",
Expand Down Expand Up @@ -1557,8 +1350,8 @@
},
"headers": {
"Link": {
"description": "Pagination links (rfc5988)",
"example": "Link: <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=def&per_page=20>; rel=\"next\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=xyz&per_page=20>; rel=\"last\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=abc&per_page=20>; rel=\"first\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=abc&per_page=20>; rel=\"prev\"",
"description": "Pagination links (rfc5988). `next` and `prev` are each present only when there is a page to go to, so a response with nothing before or after it carries no `Link` header at all. To return to the first page, call the endpoint again without a `cursor`.",
"example": "Link: <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=def&per_page=20>; rel=\"next\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=abc&per_page=20>; rel=\"prev\"",
Comment thread
jd marked this conversation as resolved.
"schema": {
"type": "string"
}
Expand Down Expand Up @@ -5499,10 +5292,10 @@
"type": "null"
}
],
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages",
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages",
"title": "Cursor"
},
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages"
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages"
},
{
"name": "per_page",
Expand Down Expand Up @@ -6206,10 +5999,10 @@
"type": "null"
}
],
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages",
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages",
"title": "Cursor"
},
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages"
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages"
},
{
"name": "per_page",
Expand Down Expand Up @@ -6402,10 +6195,10 @@
"type": "null"
}
],
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages.",
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages.",
"title": "Cursor"
},
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get first/previous/next/last pages."
"description": "The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages."
},
{
"name": "per_page",
Expand Down Expand Up @@ -6440,8 +6233,8 @@
},
"headers": {
"Link": {
"description": "Pagination links (rfc5988)",
"example": "Link: <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=def&per_page=20>; rel=\"next\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=xyz&per_page=20>; rel=\"last\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=abc&per_page=20>; rel=\"first\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=abc&per_page=20>; rel=\"prev\"",
"description": "Pagination links (rfc5988). `next` and `prev` are each present only when there is a page to go to, so a response with nothing before or after it carries no `Link` header at all. To return to the first page, call the endpoint again without a `cursor`.",
"example": "Link: <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=def&per_page=20>; rel=\"next\",\n <https://api.mergify.com/v1/repos/Mergifyio/mergify-engine/logs?cursor=abc&per_page=20>; rel=\"prev\"",
"schema": {
"type": "string"
}
Expand Down Expand Up @@ -20159,10 +19952,6 @@
"name": "applications",
"description": "Operations with applications."
},
{
"name": "badges",
"description": "Operations with badges."
},
{
"name": "ci_insights",
"description": "Operations with ci insights."
Expand Down
2 changes: 1 addition & 1 deletion public/mergify-configuration-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4762,7 +4762,7 @@
}
],
"default": null,
"description": "Pick random users and teams from the provided lists. When `random_count` is specified, `users` and `teams` can be a dictionary where the key is the login and the value is the weight to use. Weight must be between 1 and 15 included.",
"description": "Pick random users and teams from the provided lists. When `random_count` is specified, `users` and `teams` can be a dictionary where the key is the login and the value is the weight to use. Weight must be between 1 and 65535 included.",
"title": "Random Count"
},
"users": {
Expand Down
2 changes: 0 additions & 2 deletions src/components/ApiReference/openapi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,6 @@ export function preprocessSchema(schema: OpenAPISpec): OpenAPISpec {
export const TAG_LABELS: Record<string, string> = {
applications: 'Applications',
queues: 'Queues',
badges: 'Badges',
simulator: 'Simulator',
activity_log: 'Activity Log',
statistics: 'Statistics',
Expand All @@ -213,7 +212,6 @@ export const TAG_LABELS: Record<string, string> = {
export const TAG_DESCRIPTIONS: Record<string, string> = {
applications: 'Manage your Mergify application details.',
queues: 'Configure and inspect merge queues for your repositories.',
badges: 'Generate status badges for your repositories.',
simulator: 'Simulate Mergify behavior on pull requests and configurations.',
activity_log: 'Retrieve and aggregate the timeline of Mergify events for a repository.',
statistics: 'Access merge queue and CI performance statistics.',
Expand Down
1 change: 0 additions & 1 deletion src/content/navItems.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,6 @@ const navItems: NavItem[] = [
{ title: 'Statistics', path: '/api/statistics' },
{ title: 'Simulator', path: '/api/simulator' },
{ title: 'Activity Log', path: '/api/activity-log' },
{ title: 'Badges', path: '/api/badges' },
{ title: 'Scheduled Freeze', path: '/api/scheduled-freeze' },
{ title: 'CI Insights', path: '/api/ci-insights' },
{ title: 'Test Insights', path: '/api/test-insights' },
Expand Down