Last active
August 19, 2023 18:37
-
-
Save edemnati/44f8c88f8f06ef6ac2a1eca43e5ddffd to your computer and use it in GitHub Desktop.
This file contains hidden or 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
swagger: '2.0' | |
info: | |
title: Read News Articles | |
description: This API returns news articles related to an entity | |
version: 1.0.0 | |
host: [GENERATED SERVICE HOSTNAME] | |
schemes: | |
- https | |
paths: | |
/readnewsarticlesapi/start: | |
post: | |
summary: Read news articles | |
operationId: startReadNewsArticlesAPI | |
consumes: | |
- application/json | |
produces: | |
- application/json | |
security: | |
- api_key: [] | |
parameters: | |
- in: body | |
name: read | |
schema: | |
type: object | |
required: | |
- entity | |
properties: | |
entity: | |
type: string | |
description: "Entity to retrieve articles for" | |
x-google-backend: | |
address: https://us-central1-[YOUR GCP PROJECT ID].cloudfunctions.net/read_articles_firestore | |
responses: | |
'200': | |
description: A successful response | |
schema: | |
type: string | |
/readnewsarticlesuser/start: | |
post: | |
summary: Read news articles | |
operationId: startReadNewsArticlesUSER | |
consumes: | |
- application/json | |
produces: | |
- application/json | |
security: | |
- firebase: [] | |
parameters: | |
- in: body | |
name: read | |
schema: | |
type: object | |
required: | |
- entity | |
properties: | |
entity: | |
type: string | |
description: "Entity to retrieve articles for" | |
x-google-backend: | |
address: https://us-central1-[YOUR GCP PROJECT ID].cloudfunctions.net/read_articles_firestore | |
responses: | |
'200': | |
description: A successful response | |
schema: | |
type: string | |
securityDefinitions: | |
# This section configures basic authentication with an API key. | |
api_key: | |
type: "apiKey" | |
name: "key" | |
in: "query" | |
firebase: | |
authorizationUrl: "" | |
flow: "implicit" | |
type: "oauth2" | |
# Replace YOUR-PROJECT-ID with your project ID | |
x-google-issuer: "https://securetoken.google.com/[YOUR GCP PROJECT ID]" | |
x-google-jwks_uri: "https://www.googleapis.com/service_accounts/v1/metadata/x509/[email protected]" | |
x-google-audiences: "[YOUR GCP PROJECT ID]" | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment