Skip to content

Commit dce3db6

Browse files
graceparkskedwards88vgrl
authored
Updating error message for OpenAPI Descriptions check (github#31720)
Co-authored-by: Sarah Edwards <[email protected]> Co-authored-by: Vanessa <[email protected]>
1 parent fee0f17 commit dce3db6

File tree

4 files changed

+5
-4
lines changed

4 files changed

+5
-4
lines changed

data/variables/enterprise.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ prodname_emu_org: 'organization with managed users'
1212
# GitHub Connect (enterprise accounts, other unified features)
1313
## Phrase content so that the uncapitalized unified contributions or unified search variables are not used at the start of a sentence.
1414
prodname_unified_contributions: 'unified contributions'
15-
prodname_unified_search: 'unified search'
15+
prodname_unified_search: 'unified search'

data/variables/location.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ product_location: >-
44
55
# Used ONLY when you need to refer to a GHES instance in an article that is versioned for non-GHES versions.
66
# Do not use in other situations!
7-
product_location_enterprise: 'your GitHub Enterprise Server instance'
7+
product_location_enterprise: 'your GitHub Enterprise Server instance'

data/variables/product.yml

-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ prodname_ghe_managed: 'GitHub AE'
2424
prodname_ghe_one: 'GitHub One'
2525
prodname_docs: 'GitHub Docs'
2626

27-
2827
prodname_free_user: 'GitHub Free'
2928
prodname_pro: 'GitHub Pro'
3029
prodname_team: 'GitHub Team'

tests/rendering/rest.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,8 @@ This test checks that the categories and subcategories in the content/rest direc
9696
9797
If you have made changes to the categories or subcategories in the content/rest directory, either in the frontmatter or the structure of the directory, you will need to ensure that it matches the operations in the OpenAPI description. For example, if an operation is available in GHAE, the frontmatter versioning in the relevant docs category and subcategory files also need to be versioned for GHAE. If you are adding category or subcategory files to the content/rest directory, the OpenAPI dereferenced files must have at least one operation that will be shown for the versions in the category or subcategory files. If this is the case, it is likely that the description files have not been updated from github/github yet.
9898
99-
Please contact #docs-engineering or #docs-apis-and-events if you need help.`
99+
If you come across this error in an Update OpenAPI Descriptions PR it's likely that a category/subcategory has been added or removed and our content/rest directory no longer in sync with our OpenAPI Descriptions. First, please check for an open docs-internal PR that updates the content/rest directory. If you find one, merge that PR into the Update OpenAPI Descriptions PR to fix this failure. Otherwise, follow the link in the Update OpenAPI Descriptions PR body to find the author of the PR that introduced this change. Verify that the new operations are ready to be published. If yes, ask them to follow these instructions to open a docs-internal PR: https://thehub.github.com/epd/engineering/products-and-services/public-apis/rest/openapi/openapi-in-the-docs/#adding-or-changing-category-or-subcategory. If no, ask them to open a github/github PR to unpublish the operations.
100+
101+
If you have any questions contact #docs-engineering, #docs-content, or #docs-apis-and-events if you need help.`
100102
return errorMessage
101103
}

0 commit comments

Comments
 (0)