Skip to content

Commit 6c2d95b

Browse files
cyberandycyberandy
committed
Add GSC URL Inspections OpenAPI spec and generated docs
1 parent 7673660 commit 6c2d95b

File tree

7 files changed

+161
-0
lines changed

7 files changed

+161
-0
lines changed

‎api/gsc-url-inspections.yaml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
openapi: 3.0.3
2+
info:
3+
title: Google Search Console - URL Inspections
4+
version: 1.0.0
5+
description: API for requesting Google Search Console URL inspections via WordLift Manager API.
6+
contact:
7+
name: WordLift
8+
url: https://wordlift.io
9+
email: hello@wordlift.io
10+
servers:
11+
- url: https://api.wordlift.io
12+
tags:
13+
- name: Google Search Console
14+
paths:
15+
/gsc/url-inspections:
16+
post:
17+
tags:
18+
- Google Search Console
19+
summary: Inspect a URL using Google Search Console
20+
operationId: postGscUrlInspections
21+
requestBody:
22+
required: true
23+
content:
24+
application/json:
25+
schema:
26+
type: object
27+
properties:
28+
url:
29+
type: string
30+
format: uri
31+
description: The URL to inspect
32+
required:
33+
- url
34+
example:
35+
url: "https://www.glasses.com/gl-us/burberry/8056262081037"
36+
responses:
37+
'200':
38+
description: Inspection request accepted / result
39+
content:
40+
application/json:
41+
schema:
42+
type: object
43+
properties:
44+
status:
45+
type: string
46+
data:
47+
type: object
48+
'400':
49+
description: Bad Request
50+
'401':
51+
description: Authentication Failure
52+
security:
53+
- ApiKey: []
54+
components:
55+
securitySchemes:
56+
ApiKey:
57+
type: apiKey
58+
in: header
59+
name: Authorization
60+
description: "`Key {your key}`"

‎docs/api/gsc-url-inspections/google-search-console-url-inspections.info.mdx‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
id: google-search-console-url-inspections
3+
title: "Google Search Console - URL Inspections"
4+
description: "API for requesting Google Search Console URL inspections via WordLift Manager API."
5+
sidebar_label: Introduction
6+
sidebar_position: 0
7+
hide_title: true
8+
custom_edit_url: null
9+
---
10+
11+
import ApiLogo from "@theme/ApiLogo";
12+
import SchemaTabs from "@theme/SchemaTabs";
13+
import TabItem from "@theme/TabItem";
14+
import Export from "@theme/ApiDemoPanel/Export";
15+
16+
<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 1.0.0</span>
17+
18+
# Google Search Console - URL Inspections
19+
20+
21+
22+
API for requesting Google Search Console URL inspections via WordLift Manager API.
23+
24+
<div style={{"marginBottom":"2rem"}}><h2 id={"authentication"} style={{"marginBottom":"1rem"}}>Authentication</h2><SchemaTabs className={"openapi-tabs__security-schemes"}><TabItem label={"API Key: ApiKey"} value={"ApiKey"}>
25+
26+
`Key {your key}`
27+
28+
<div><table><tbody><tr><th>Security Scheme Type:</th><td>apiKey</td></tr><tr><th>Header parameter name:</th><td>Authorization</td></tr></tbody></table></div></TabItem></SchemaTabs></div><div style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>Contact</h3><span>WordLift: <a href={"mailto:hello@wordlift.io"}>hello@wordlift.io</a></span><span>URL: <a href={"https://wordlift.io"}>https://wordlift.io</a></span></div>
29+

‎docs/api/gsc-url-inspections/google-search-console.tag.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
id: google-search-console
3+
title: "Google Search Console"
4+
description: "Google Search Console"
5+
custom_edit_url: null
6+
---
7+
8+
9+
10+
```mdx-code-block
11+
import DocCardList from '@theme/DocCardList';
12+
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
13+
14+
<DocCardList items={useCurrentSidebarCategory().items}/>
15+
```
16+

‎docs/api/gsc-url-inspections/post-gsc-url-inspections.api.mdx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
id: post-gsc-url-inspections
3+
title: "Inspect a URL using Google Search Console"
4+
description: "Inspect a URL using Google Search Console"
5+
sidebar_label: "Inspect a URL using Google Search Console"
6+
hide_title: true
7+
hide_table_of_contents: true
8+
api: {"tags":["Google Search Console"],"operationId":"postGscUrlInspections","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"The URL to inspect"}},"required":["url"]},"example":{"url":"https://www.glasses.com/gl-us/burberry/8056262081037"}}}},"responses":{"200":{"description":"Inspection request accepted / result","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"data":{"type":"object"}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Authentication Failure"}},"security":[{"ApiKey":[]}],"description":"Inspect a URL using Google Search Console","method":"post","path":"/gsc/url-inspections","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"`Key {your key}`"}},"jsonRequestBodyExample":{"url":"string"},"info":{"title":"Google Search Console - URL Inspections","version":"1.0.0","description":"API for requesting Google Search Console URL inspections via WordLift Manager API.","contact":{"name":"WordLift","url":"https://wordlift.io","email":"hello@wordlift.io"}},"postman":{"name":"Inspect a URL using Google Search Console","description":{"type":"text/plain"},"url":{"path":["gsc","url-inspections"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"<API Key>","key":"value"},{"type":"any","value":"header","key":"in"}]}}}
9+
sidebar_class_name: "post api-method"
10+
info_path: api/gsc-url-inspections/google-search-console-url-inspections
11+
custom_edit_url: null
12+
---
13+
14+
import ApiTabs from "@theme/ApiTabs";
15+
import MimeTabs from "@theme/MimeTabs";
16+
import ParamsItem from "@theme/ParamsItem";
17+
import ResponseSamples from "@theme/ResponseSamples";
18+
import SchemaItem from "@theme/SchemaItem";
19+
import SchemaTabs from "@theme/SchemaTabs";
20+
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
21+
import TabItem from "@theme/TabItem";
22+
23+
## Inspect a URL using Google Search Console
24+
25+
26+
27+
Inspect a URL using Google Search Console
28+
29+
<MimeTabs><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"The URL to inspect"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
30+
31+
Inspection request accepted / result
32+
33+
</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"data"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"status\": \"string\",\n \"data\": {}\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
34+
35+
Bad Request
36+
37+
</div><div></div></TabItem><TabItem label={"401"} value={"401"}><div>
38+
39+
Authentication Failure
40+
41+
</div><div></div></TabItem></ApiTabs></div>
42+

‎docs/api/gsc-url-inspections/sidebar.js‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docusaurus.config.js‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -489,6 +489,14 @@ const config = {
489489
categoryLinkSource: "tag",
490490
},
491491
},
492+
"gsc-url-inspections": {
493+
specPath: "api/gsc-url-inspections.yaml",
494+
outputDir: "docs/api/gsc-url-inspections",
495+
sidebarOptions: {
496+
groupPathsBy: "tag",
497+
categoryLinkSource: "tag",
498+
},
499+
},
492500
},
493501
},
494502
],

‎sidebars.js‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,11 @@ const sidebars = {
254254
label: "Manager",
255255
items: require("./docs/api/manager/sidebar.js"),
256256
},
257+
{
258+
type: "category",
259+
label: "Google Search Console",
260+
items: require("./docs/api/gsc-url-inspections/sidebar.js"),
261+
},
257262
{
258263
type: "category",
259264
label: "Middleware",

0 commit comments

Comments
 (0)