jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-07 00:01:39 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #24183 from github/repo-sync

Browse Source 
repo sync
This commit is contained in:
Octomerger Bot
2023-02-27 11:35:41 -08:00
committed by GitHub
parent 11a14123bc d34829ed16
commit a63e62269b
20 changed files with 334 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
components/rest/RestCodeSamples.tsx
View File

@@ -20,6 +20,7 @@ import { useVersion } from 'components/hooks/useVersion'
type Props = {
slug: string
operation: Operation
heading: string
}
const GHCLIKEY = 'ghcli'
@@ -41,7 +42,7 @@ function getLanguageHighlight(selectedLanguage: string) {
return selectedLanguage === JSKEY ? 'javascript' : 'curl'
}
export function RestCodeSamples({ operation, slug }: Props) {
export function RestCodeSamples({ operation, slug, heading }: Props) {
const { t } = useTranslation('products')
const { isEnterpriseServer } = useVersion()
@@ -228,7 +229,7 @@ export function RestCodeSamples({ operation, slug }: Props) {
return (
<>
<h3 className="mt-0 pt-0 h4" id={`${slug}--code-samples`}>
<a href={`#${slug}--code-samples`}>{`${t('rest.reference.code_samples')}`}</a>
<a href={`#${slug}--code-samples`}>{heading}</a>
</h3>
{/* Display an example selector if more than one example */}
@@ -299,11 +300,12 @@ export function RestCodeSamples({ operation, slug }: Props) {
</div>
{/* Response section */}
<h5
<div
className="mt-5 mb-2 h5"
dangerouslySetInnerHTML={{
__html: displayedExample.response.description || t('rest.reference.response'),
}}
></h5>
></div>
<div className="border rounded-1">
{displayedExample.response.schema ? (

43
components/rest/RestOperation.tsx
View File

@@ -67,7 +67,10 @@ export function RestOperation({ operation }: Props) {
<ParameterTable
slug={titleSlug}
numPreviews={numPreviews}
heading={t('rest.reference.parameters')}
heading={t('rest.reference.parameters').replace(
'{{ RESTOperationTitle }}',
operation.title
)}
headers={headers}
parameters={operation.parameters}
bodyParameters={operation.bodyParameters}
@@ -75,16 +78,48 @@ export function RestOperation({ operation }: Props) {
)}
{hasStatusCodes && (
<RestStatusCodes statusCodes={operation.statusCodes} slug={titleSlug} />
<RestStatusCodes
statusCodes={operation.statusCodes}
slug={titleSlug}
heading={t('rest.reference.http_status_code').replace(
'{{ RESTOperationTitle }}',
operation.title
)}
/>
)}
</div>
<div
className="col-md-12 col-lg-6 position-sticky flex-self-start"
style={{ top: '6.5em' }}
>
{hasCodeSamples && <RestCodeSamples operation={operation} slug={titleSlug} />}
{hasCodeSamples && (
<RestCodeSamples
operation={operation}
slug={titleSlug}
heading={t('rest.reference.code_samples').replace(
'{{ RESTOperationTitle }}',
operation.title
)}
/>
)}
{numPreviews > 0 && <RestPreviewNotice slug={titleSlug} previews={operation.previews} />}
{numPreviews > 0 && (
<RestPreviewNotice
slug={titleSlug}
previews={operation.previews}
heading={
operation.previews.length > 1
? `${t('rest.reference.preview_notices').replace(
'{{ RESTOperationTitle }}',
operation.title
)}`
: `${t('rest.reference.preview_notice').replace(
'{{ RESTOperationTitle }}',
operation.title
)}`
}
/>
)}
</div>
</div>
</div>

12
components/rest/RestPreviewNotice.tsx
View File

@@ -1,20 +1,14 @@
import { useTranslation } from 'components/hooks/useTranslation'
type Props = {
slug: string
previews: Array<string>
heading: string
}
export function RestPreviewNotice({ slug, previews }: Props) {
const { t } = useTranslation('products')
export function RestPreviewNotice({ slug, previews, heading }: Props) {
return (
<>
<h3 className="h4" id={`${slug}-preview-notices`}>
<a href={`#${slug}-preview-notices`}>
{previews.length > 1
? `${t('rest.reference.preview_notices')}`
: `${t('rest.reference.preview_notice')}`}
</a>
<a href={`#${slug}-preview-notices`}>{heading}</a>
</h3>
{previews.map((preview, index) => (
<div

5
components/rest/RestStatusCodes.tsx
View File

@@ -4,15 +4,16 @@ import { StatusCode } from './types'
type Props = {
statusCodes: Array<StatusCode>
slug: string
heading: string
}
export function RestStatusCodes({ statusCodes, slug }: Props) {
export function RestStatusCodes({ statusCodes, slug, heading }: Props) {
const { t } = useTranslation('products')
return (
<>
<h3 className="mt-4 mb-3 pt-3 h4" id={`${slug}--status-codes`}>
<a href={`#${slug}--status-codes`}>{t('rest.reference.http_status_code')}</a>
<a href={`#${slug}--status-codes`}>{heading}</a>
</h3>
<table>

10
data/ui.yml
View File

@@ -133,15 +133,15 @@ products:
in: In
description: Description
notes: Notes
parameters: Parameters
parameters: Parameters for "{{ RESTOperationTitle }}"
response: Response
example_response: Example response
status_code: Status code
http_status_code: HTTP response status codes
http_status_code: HTTP response status codes for "{{ RESTOperationTitle }}"
code_sample: Code sample
code_samples: Code samples
preview_notice: Preview notice
preview_notices: Preview notices
code_samples: Code samples for "{{ RESTOperationTitle }}"
preview_notice: Preview notice for "{{ RESTOperationTitle }}"
preview_notices: Preview notices for "{{ RESTOperationTitle }}"
preview_header_is_required: This header is <strong>required</strong>
preview_notice_to_change: This API is under preview and subject to change
works_with: Works with

61
src/rest/data/api.github.com.2022-11-28/schema.json
View File

File diff suppressed because one or more lines are too long

61
src/rest/data/ghec.2022-11-28/schema.json
View File

File diff suppressed because one or more lines are too long

28
src/rest/data/ghes-3.4/schema.json
View File

File diff suppressed because one or more lines are too long

28
src/rest/data/ghes-3.5/schema.json
View File

File diff suppressed because one or more lines are too long

28
src/rest/data/ghes-3.6/schema.json
View File

File diff suppressed because one or more lines are too long

28
src/rest/data/ghes-3.7/schema.json
View File

File diff suppressed because one or more lines are too long

38
src/rest/data/ghes-3.8/schema.json
View File

File diff suppressed because one or more lines are too long

28
src/rest/data/github.ae/schema.json
View File

File diff suppressed because one or more lines are too long

26
src/webhooks/data/api.github.com/schema.json
View File

@@ -165800,19 +165800,7 @@
"name": "inputs",
"in": "body",
"description": "",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "name",
"description": ""
},
{
"type": "string",
"name": "number",
"description": ""
}
]
"isRequired": true
},
{
"type": "object",
@@ -167056,6 +167044,12 @@
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"description": "<p>The time that the job created.</p>",
"isRequired": true
},
{
"type": "string",
"name": "head_sha",
@@ -167803,6 +167797,12 @@
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"description": "<p>The time that the job created.</p>",
"isRequired": true
},
{
"type": "string",
"name": "head_sha",

26
src/webhooks/data/ghec/schema.json
View File

@@ -165800,19 +165800,7 @@
"name": "inputs",
"in": "body",
"description": "",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "name",
"description": ""
},
{
"type": "string",
"name": "number",
"description": ""
}
]
"isRequired": true
},
{
"type": "object",
@@ -167056,6 +167044,12 @@
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"description": "<p>The time that the job created.</p>",
"isRequired": true
},
{
"type": "string",
"name": "head_sha",
@@ -167803,6 +167797,12 @@
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"description": "<p>The time that the job created.</p>",
"isRequired": true
},
{
"type": "string",
"name": "head_sha",

26
src/webhooks/data/ghes-3.7/schema.json
View File

@@ -165677,19 +165677,7 @@
"name": "inputs",
"in": "body",
"description": "",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "name",
"description": ""
},
{
"type": "string",
"name": "number",
"description": ""
}
]
"isRequired": true
},
{
"type": "object",
@@ -165959,6 +165947,12 @@
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"description": "<p>The time that the job created.</p>",
"isRequired": true
},
{
"type": "string",
"name": "head_sha",
@@ -166219,6 +166213,12 @@
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"description": "<p>The time that the job created.</p>",
"isRequired": true
},
{
"type": "string",
"name": "head_sha",

26
src/webhooks/data/ghes-3.8/schema.json
View File

@@ -165920,19 +165920,7 @@
"name": "inputs",
"in": "body",
"description": "",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "name",
"description": ""
},
{
"type": "string",
"name": "number",
"description": ""
}
]
"isRequired": true
},
{
"type": "object",
@@ -167176,6 +167164,12 @@
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"description": "<p>The time that the job created.</p>",
"isRequired": true
},
{
"type": "string",
"name": "head_sha",
@@ -167923,6 +167917,12 @@
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"description": "<p>The time that the job created.</p>",
"isRequired": true
},
{
"type": "string",
"name": "head_sha",

26
src/webhooks/data/github.ae/schema.json
View File

@@ -165120,19 +165120,7 @@
"name": "inputs",
"in": "body",
"description": "",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "name",
"description": ""
},
{
"type": "string",
"name": "number",
"description": ""
}
]
"isRequired": true
},
{
"type": "object",
@@ -166376,6 +166364,12 @@
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"description": "<p>The time that the job created.</p>",
"isRequired": true
},
{
"type": "string",
"name": "head_sha",
@@ -167123,6 +167117,12 @@
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"description": "<p>The time that the job created.</p>",
"isRequired": true
},
{
"type": "string",
"name": "head_sha",

10
tests/fixtures/data/ui.yml vendored
View File

@@ -133,15 +133,15 @@ products:
in: In
description: Description
notes: Notes
parameters: Parameters
parameters: Parameters for "{{ RESTOperationTitle }}"
response: Response
example_response: Example response
status_code: Status code
http_status_code: HTTP response status codes
http_status_code: HTTP response status codes for "{{ RESTOperationTitle }}"
code_sample: Code sample
code_samples: Code samples
preview_notice: Preview notice
preview_notices: Preview notices
code_samples: Code samples for "{{ RESTOperationTitle }}"
preview_notice: Preview notice for "{{ RESTOperationTitle }}"
preview_notices: Preview notices for "{{ RESTOperationTitle }}"
preview_header_is_required: This header is <strong>required</strong>
preview_notice_to_change: This API is under preview and subject to change
works_with: Works with

30
tests/rendering/rest.js
View File

@@ -152,6 +152,36 @@ describe('REST references docs', () => {
}
}
})
describe('headings', () => {
test('rest pages do not render any headings with duplicate text', async () => {
const $ = await getDOM('/en/rest/actions/artifacts')
const headingText = $('body')
.find('h2, h3, h4, h5, h6')
.map((i, el) => $(el).text())
.get()
.sort()
const dupes = headingText.filter((item, index) => headingText.indexOf(item) !== index)
const message = `The following duplicate heading texts were found: ${dupes.join(', ')}`
expect(dupes.length, message).toBe(0)
})
test('rest pages do not render any headings with duplicate ids', async () => {
const $ = await getDOM('/en/rest/actions/artifacts')
const headingIDs = $('body')
.find('h2, h3, h4, h5, h6')
.map((i, el) => $(el).attr('id'))
.get()
.sort()
const dupes = headingIDs.filter((item, index) => headingIDs.indexOf(item) !== index)
const message = `The following duplicate heading IDs were found: ${dupes.join(', ')}`
expect(dupes.length, message).toBe(0)
})
})
})
function formatErrors(differences) {