diff --git a/public/_redirects b/public/_redirects index 28155f886e..d97739fbdb 100644 --- a/public/_redirects +++ b/public/_redirects @@ -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 diff --git a/public/api-schemas.json b/public/api-schemas.json index 6e6f54ef3e..cb2d6f4d85 100644 --- a/public/api-schemas.json +++ b/public/api-schemas.json @@ -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": [ @@ -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", @@ -1557,8 +1350,8 @@ }, "headers": { "Link": { - "description": "Pagination links (rfc5988)", - "example": "Link: ; rel=\"next\",\n ; rel=\"last\",\n ; rel=\"first\",\n ; 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: ; rel=\"next\",\n ; rel=\"prev\"", "schema": { "type": "string" } @@ -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", @@ -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", @@ -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", @@ -6440,8 +6233,8 @@ }, "headers": { "Link": { - "description": "Pagination links (rfc5988)", - "example": "Link: ; rel=\"next\",\n ; rel=\"last\",\n ; rel=\"first\",\n ; 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: ; rel=\"next\",\n ; rel=\"prev\"", "schema": { "type": "string" } @@ -20159,10 +19952,6 @@ "name": "applications", "description": "Operations with applications." }, - { - "name": "badges", - "description": "Operations with badges." - }, { "name": "ci_insights", "description": "Operations with ci insights." diff --git a/public/mergify-configuration-schema.json b/public/mergify-configuration-schema.json index 7a16c03dfb..4aaf890ef3 100644 --- a/public/mergify-configuration-schema.json +++ b/public/mergify-configuration-schema.json @@ -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": { diff --git a/src/components/ApiReference/openapi.ts b/src/components/ApiReference/openapi.ts index 772388d2fe..f63a85020a 100644 --- a/src/components/ApiReference/openapi.ts +++ b/src/components/ApiReference/openapi.ts @@ -198,7 +198,6 @@ export function preprocessSchema(schema: OpenAPISpec): OpenAPISpec { export const TAG_LABELS: Record = { applications: 'Applications', queues: 'Queues', - badges: 'Badges', simulator: 'Simulator', activity_log: 'Activity Log', statistics: 'Statistics', @@ -213,7 +212,6 @@ export const TAG_LABELS: Record = { export const TAG_DESCRIPTIONS: Record = { 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.', diff --git a/src/content/navItems.tsx b/src/content/navItems.tsx index fefd846727..7679c404b6 100644 --- a/src/content/navItems.tsx +++ b/src/content/navItems.tsx @@ -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' },