-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
35 changed files
with
170 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,40 @@ | ||
openapi: 3.0.0 | ||
openapi: 3.0.1 | ||
info: | ||
title: SEO Content Analysis API | ||
version: 1.0.0 | ||
version: "1.0" | ||
description: This API assesses the match between a URL or text content, a query, and an intent, using advanced SEO techniques. | ||
|
||
termsOfService: https://wordlift.io/terms-of-service/ | ||
contact: | ||
name: WordLift | ||
url: https://wordlift.io | ||
email: [email protected] | ||
license: | ||
name: (c) copyright 2022-present WordLift | ||
url: https://wordlift.io | ||
servers: | ||
- url: https://api.wordlift.io | ||
|
||
tags: | ||
- name: SEO Scores | ||
description: Create a SEO Score | ||
|
||
paths: | ||
/score: | ||
post: | ||
summary: Analyze SEO relevance and trustworthiness | ||
operationId: analyzeSEO | ||
tags: | ||
- SEO Analysis | ||
- SEO Scores | ||
summary: Create | ||
operationId: createSEOScore | ||
requestBody: | ||
description: body | ||
required: true | ||
content: | ||
application/json: | ||
schema: | ||
type: object | ||
oneOf: | ||
- required: [url] | ||
- required: [text] | ||
# oneOf: | ||
# - required: [url] | ||
# - required: [text] | ||
properties: | ||
url: | ||
type: string | ||
|
@@ -38,7 +50,7 @@ paths: | |
description: Narrative description of the intent behind the query. | ||
responses: | ||
'200': | ||
description: Analysis result | ||
description: OK | ||
content: | ||
application/json: | ||
schema: | ||
|
@@ -50,17 +62,19 @@ paths: | |
description: Traffic light system indicating the match. M for match, T for trustworthiness, O for overall score. | ||
'400': | ||
description: Bad request | ||
content: { } | ||
'401': | ||
description: Unauthorized | ||
content: { } | ||
'500': | ||
description: Internal server error | ||
content: { } | ||
security: | ||
- ApiKey: [] | ||
|
||
components: | ||
securitySchemes: | ||
ApiKeyAuth: | ||
ApiKey: | ||
type: apiKey | ||
in: header | ||
name: Authorization | ||
|
||
security: | ||
- ApiKeyAuth: [] | ||
in: header |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.