Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🧑‍💻 Replace content endpoint with batch endpoint #49

Merged
merged 3 commits into from
May 24, 2024
Merged

🧑‍💻 Replace content endpoint with batch endpoint #49

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7266b39
:technologist: Replace content endpoint with batch endpoint
gkumbhat May 24, 2024
0a07c0d
:memo: Add description for contents object in detectors API design
gkumbhat May 24, 2024
8afaa9b
Update docs/api/openapi_detector_api.yaml
gkumbhat May 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 29 additions & 22 deletions docs/api/openapi_detector_api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ info:
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.0.1
paths:
/api/v1/text/content:
/api/v1/text/contents:
post:
summary: Text Content Analysis Unary Handler
description: >-
Expand All @@ -26,7 +26,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/TextAnalysisHttpRequest'
$ref: '#/components/schemas/ContentAnalysisHttpRequest'
responses:
'200':
description: Successful Response
Expand All @@ -35,21 +35,22 @@ paths:
schema:
type: array
items:
$ref: '#/components/schemas/TextAnalysisResponse'
$ref: '#/components/schemas/ContentsAnalysisResponse'
title: >-
Response Text Content Analysis Unary Handler Api V1 Text
Content Post
example:
- start: 15
end: 25
detection_type: pii
detection: EmailAddress
score: 0.99
- start: 105
end: 116
detection_type: pii
detection: SocialSecurity
score: 0.99
-
- start: 15
end: 25
detection_type: pii
detection: EmailAddress
score: 0.99
- start: 105
end: 116
detection_type: pii
detection: SocialSecurity
score: 0.99
'404':
description: Resource Not Found
content:
Expand Down Expand Up @@ -501,19 +502,25 @@ components:

Methods can be added to enumerations, and members can have their own
attributes -- see the documentation for details.
TextAnalysisHttpRequest:
ContentAnalysisHttpRequest:
properties:
content:
type: string
title: Content
example: >-
Your email is test@ibm.com! Only the next instance of email will be
processed. test@ibm.com. Your SSN is 123-45-6789.
contents:
type: array
title: Contents
items:
type: string
example: >-
Your email is test@ibm.com! Only the next instance of email will be
processed. test@ibm.com. Your SSN is 123-45-6789.
type: object
required:
- content
- contents
title: TextAnalysisHttpRequest
TextAnalysisResponse:
ContentsAnalysisResponse:
type: array
items:
$ref: '#/components/schemas/ContentAnalysisResponse'
ContentAnalysisResponse:
properties:
start:
type: integer
Expand Down