Skip to content

Commit f52bae2

Browse files
sverasvera
authored
Merge branch 'main' into LYNX-679
2 parents b34789d + 089bdaa commit f52bae2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+101783
-176520
lines changed

‎.github/workflows/publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
uses: actions/checkout@v4
1616

1717
- name: Get pathPrefix
18-
uses: actions/github-script@v6
18+
uses: actions/github-script@v7
1919
id: get_path_prefix
2020
with:
2121
script: |
@@ -63,7 +63,7 @@ jobs:
6363
cache-dependency-path: 'yarn.lock'
6464

6565
- name: Gatsby Cache
66-
uses: actions/cache@v3.3.2
66+
uses: actions/cache@v4
6767
with:
6868
path: |
6969
public

‎.github/workflows/stage.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
uses: actions/checkout@v4
2525

2626
- name: Get pathPrefix
27-
uses: actions/github-script@v6
27+
uses: actions/github-script@v7
2828
id: get_path_prefix
2929
with:
3030
script: |
@@ -74,7 +74,7 @@
7474
cache-dependency-path: 'yarn.lock'
7575

7676
- name: Gatsby Cache
77-
uses: actions/cache@v3.3.2
77+
uses: actions/cache@v4
7878
with:
7979
path: |
8080
public

‎.github/workflows/test-pull-request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
# Use full version number to avoid cases when a next
6161
# released version is buggy
6262
# About slim image: https://github.com/github/super-linter#slim-image
63-
uses: super-linter/super-linter/slim@v7.0.0
63+
uses: super-linter/super-linter/slim@v7.2.0
6464
env:
6565
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
6666
DEFAULT_BRANCH: main

‎package.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"url": "https://github.com/AdobeDocs/commerce-webapi"
88
},
99
"dependencies": {
10-
"@adobe/gatsby-theme-aio": "4.14.17",
10+
"@adobe/gatsby-theme-aio": "4.14.19",
1111
"gatsby": "4.22.0",
1212
"react": "^17.0.2",
1313
"react-dom": "^17.0.2"
@@ -32,8 +32,7 @@
3232
"test": "remark src/pages --quiet --frail",
3333
"build:spectaql": "spectaql --target-file index.html --config spectaql/config.yml",
3434
"build:spectaql:2.4.6": "spectaql --target-file index.html --config spectaql/config_2.4.6.yml",
35-
"dev:spectaql": "spectaql --development-mode-live --config spectaql/config.yml",
36-
"lint": "docker run --rm -e RUN_LOCAL=true --env-file '.github/super-linter.env' -v \"$PWD\":/tmp/lint github/super-linter:slim-v5"
35+
"dev:spectaql": "spectaql --development-mode-live --config spectaql/config.yml"
3736
},
3837
"packageManager": "yarn@3.2.4"
3938
}

‎spectaql/comdox-theme/views/partials/graphql/_query-or-mutation-or-subscription.hbs

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
<section id="{{./htmlId}}"
2+
class="operation operation-{{#if isQuery}}query{{else if isMutation}}mutation{{else if isSubscription}}subscription{{else}}unknown{{/if}}"
3+
data-traverse-target="{{./htmlId}}">
4+
{{# unless @first }}
5+
{{#if parentHtmlId }}
6+
<div class="operation-group-name">
7+
<a href="#group-{{./parentHtmlId}}">{{./parentName}}</a>
8+
</div>
9+
{{/if}}
10+
{{/unless}}
11+
12+
<h2 class="operation-heading {{#if (and isDeprecated (not @root.info.x-hideIsDeprecated)) }}operation-deprecated{{/if}}">
13+
{{md (codify name) stripParagraph="true"}}
14+
</h2>
15+
16+
{{#if (and deprecationReason (not @root.info.x-hideDeprecationReason))}}
17+
<div class="doc-row">
18+
<div class="doc-copy">
19+
<div class="doc-copy-section">
20+
<div class="deprecation-reason">
21+
{{ md deprecationReason stripParagraph=true }}
22+
</div>
23+
</div>
24+
</div>
25+
</div>
26+
{{/if}}
27+
28+
{{#if description}}
29+
<div class="doc-row">
30+
<div class="doc-copy">
31+
<div class="operation-description doc-copy-section">
32+
<h5>Description</h5>
33+
{{ md (interpolateReferences description) }}
34+
</div>
35+
</div>
36+
</div>
37+
{{/if}}
38+
39+
<div class="doc-row">
40+
<div class="doc-copy">
41+
{{#if response}}
42+
<div class="operation-response doc-copy-section">
43+
<h5>Response</h5>
44+
<p>
45+
Returns
46+
{{! If it's got items, then it's an array, and we don't care about the indefiniteArticle }}
47+
{{#unless response.isArray }}
48+
{{ indefiniteArticle response.underlyingType.name }}
49+
{{/unless}}
50+
{{~ md (mdTypeLink . codify=true) stripParagraph=true }}
51+
</p>
52+
</div>
53+
{{/if}}
54+
{{>graphql/_query-or-mutation-arguments}}
55+
</div>
56+
57+
<div class="doc-examples">
58+
{{#if (firstTruthy query mutation subscription)}}
59+
<h4 class="example-heading">Example</h4>
60+
61+
<div class="example-section example-section-is-code operation-query-example">
62+
<h5>Query</h5>
63+
{{printGraphQL (firstTruthy query mutation subscription)}}
64+
</div>
65+
66+
{{#if variables}}
67+
<div class="example-section example-section-is-code operation-variables-example">
68+
<h5>Variables</h5>
69+
{{printJSON variables}}
70+
</div>
71+
{{/if}}
72+
{{#if response.data}}
73+
<div class="example-section example-section-is-code operation-response-example">
74+
<h5>Response</h5>
75+
{{printJSON response.data}}
76+
</div>
77+
{{/if}}
78+
{{/if}}
79+
</div>
80+
<a href="#top">back to top</a>
81+
</div>
82+
</section>

‎spectaql/comdox-theme/views/partials/graphql/type.hbs

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<section id="{{./htmlId}}"
2+
class="definition definition-{{ kebabCase ./kind defaultValue='unknown' }}"
3+
data-traverse-target="{{./htmlId}}">
4+
{{#unless @first }}
5+
{{#if parentHtmlId }}
6+
<div class="definition-group-name">
7+
<a href="#group-{{parentHtmlId}}">{{./parentName}}</a>
8+
</div>
9+
{{/if}}
10+
{{/unless}}
11+
{{#if name}}
12+
<h2 class="definition-heading">{{name}}{{!-- - {{kind}} --}}</h2>
13+
{{/if}}
14+
15+
<div class="doc-row">
16+
{{#if (equal ./kind "SCALAR")}}
17+
{{>graphql/kinds/scalar .}}
18+
{{else if (equal ./kind "OBJECT")}}
19+
{{>graphql/kinds/object .}}
20+
{{else if (equal ./kind "ENUM")}}
21+
{{>graphql/kinds/enum .}}
22+
{{else if (equal ./kind "INPUT_OBJECT")}}
23+
{{>graphql/kinds/input-object .}}
24+
{{else if (equal ./kind "UNION")}}
25+
{{>graphql/kinds/union .}}
26+
{{else if (equal ./kind "INTERFACE")}}
27+
{{>graphql/kinds/interface .}}
28+
{{else}}
29+
{{ log "unknown type.hbs" . }}
30+
{{/if}}
31+
<a href="#top">back to top</a>
32+
</div>
33+
</section>

‎spectaql/comdox-theme/views/partials/layout/page.hbs

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<div id="page" class="drawer-layout">
2+
{{! DO THE NAVIGATION }}
3+
<div id="sidebar">
4+
<div class="sidebar-top-container">
5+
<div id="logo">
6+
{{#if logoData }}
7+
<img src="data:image/png;base64,{{logoData}}" title="{{info.title}}" />
8+
{{else if logoUrl}}
9+
<a href="https://developer.adobe.com/commerce/webapi/graphql/"><img src="{{logoUrl}}" title="{{info.title}}" />
10+
<strong class="spectrum-Heading spectrum-Heading--sizeXXS" style="text-align: center; display: block; color: #FA0F00;">Adobe&nbsp;Developer</strong>
11+
</a>
12+
{{else if logoImageName}}
13+
<img src="images/{{logoImageName}}" title="{{info.title}}" />
14+
{{/if}}
15+
</div>
16+
<button class="close-button" type="button">
17+
<span aria-hidden="true">×</span>
18+
<span class="sr-only">Close menu</span>
19+
</button>
20+
</div>
21+
{{>layout/nav/main}}
22+
</div>
23+
24+
<div id="docs">
25+
{{>layout/nav/mobile-navbar}}
26+
{{>layout/content/main}}
27+
<div class="drawer-overlay"></div>
28+
</div>
29+
</div>

‎spectaql/config.yml

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
spectaql:
77
# Optional Boolean indicating whether to omit the HTML <body/> and generate the documentation content only
88
# Default: false
9-
embeddable: true
9+
# embeddable: true
1010

1111
# Optional Boolean indicating whether to embed all resources (CSS and JS) into the same file
1212
# Default: false
13-
oneFile: false
13+
oneFile: true
1414

1515
# Optional path to the target build directory.
1616
# Set to null to not write the output to the filesystem, making it only available via the API (default: public)
@@ -31,7 +31,7 @@ spectaql:
3131
# Optional URL to an image to use in your logo. This string will be provided as-is
3232
# to the HTML output. Should not be used with logoFile and its related options as
3333
# this will take precedence over the logoFile.
34-
# logoUrl: https://yoursite.com/images/logo.png
34+
logoUrl: https://developer.adobe.com/shared/images/adobe-social-share.png
3535
# Control the height of your logo here. Can be useful if your logo is SVG or an
3636
# inappropriate size.
3737
#
@@ -51,7 +51,7 @@ spectaql:
5151
# Optional URL to an image to use in your favicon. This string will be provided as-is
5252
# to the HTML output. Should not be used with faviconFile and its related options as
5353
# this will take precedence over the faviconFile.
54-
# faviconUrl: https://yoursite.com/images/favicon.png
54+
faviconUrl: https://www.adobe.com/favicon.ico
5555

5656
# Optional string specifying a path to a theme directory to use for your build.
5757
#
@@ -64,7 +64,7 @@ spectaql:
6464
# "spectaql": Outputs the same HTML structure as the "default" theme, but with some CSS enhancements
6565
#
6666
# Default: "default"
67-
# themeDir: path/to/theme
67+
themeDir: spectaql/comdox-theme
6868
theme: spectaql
6969

7070
# If you're embedding SpectaQL's output, and you've got something like a Nav Bar that
@@ -439,8 +439,8 @@ info:
439439
# A non-standard array of items to display in your Introduction Area
440440
x-introItems:
441441
# Can be a Title (for the Nav panel) + URL to simply add a link to somewhere
442-
- title: WebAPI guide
443-
url: https://developer.adobe.com/commerce/webapi/
442+
- title: Back to the GraphQL guide
443+
url: https://developer.adobe.com/commerce/webapi/graphql/reference/
444444
# Can be a Title (for the Nav panel) + description (for the Content panel)
445445
# - title: Important thing 1
446446
# description: Some important stuff we wanted you to know. Supports `markdown`
@@ -454,4 +454,3 @@ info:
454454

455455
# If not using introspection.url OR servers[], you need to provide x-url
456456
# x-url: https://yoursite.com/graphql
457-

0 commit comments

Comments
 (0)