Skip to content

Commit

Permalink
Add authentication
Browse files Browse the repository at this point in the history
  • Loading branch information
mchompalova committed May 20, 2021
1 parent b93f3a7 commit 1604435
Showing 1 changed file with 39 additions and 4 deletions.
43 changes: 39 additions & 4 deletions _ft/api.yml
@@ -1,14 +1,22 @@
openapi: 3.0.0
info:
title: Public Annotations API
description: Provides a public API for Annotations stored in a Neo4J graph database
description: Provides a public API for annotations stored in a Neo4J graph database
version: 2.0.0
contact:
name: Universal Publishing
email: Universal.Publishing.Platform@ft.com
license:
name: Apache-2.0
url: http://www.apache.org/licenses/LICENSE-2.0

servers:
- url: https://api.ft.com/
- url: https://api-t.ft.com/

security:
- ApiKeyAuth: []

paths:
"/content/{contentUUID}/annotations":
get:
Expand Down Expand Up @@ -138,9 +146,14 @@ paths:
"503":
description: Service Unavailable if it cannot connect to Neo4j.
/__health:
servers:
- url: https://upp-prod-delivery-glb.upp.ft.com/__public-annotations-api/
- url: https://upp-staging-delivery-glb.upp.ft.com/__public-annotations-api/
get:
summary: Healthchecks
description: Runs application healthchecks and returns FT Healthcheck style json.
description: Runs application healthchecks and returns FT healthcheck style JSON.
security:
- BasicAuth: []
tags:
- Health
responses:
Expand All @@ -150,20 +163,30 @@ paths:
the overall `ok` property to see whether or not the application is
healthy.
/__build-info:
servers:
- url: https://upp-prod-delivery-glb.upp.ft.com/__public-annotations-api/
- url: https://upp-staging-delivery-glb.upp.ft.com/__public-annotations-api/
get:
summary: Build Information
description: Returns application build info, such as the git repository and revision,
the golang version it was built with, and the app release version.
security:
- BasicAuth: []
tags:
- Info
responses:
"200":
description: Outputs build information as described in the summary.
/__gtg:
get:
servers:
- url: https://upp-prod-delivery-glb.upp.ft.com/__public-annotations-api/
- url: https://upp-staging-delivery-glb.upp.ft.com/__public-annotations-api/
summary: Good To Go
description: Lightly healthchecks the application, and returns a 200 if it's
Good-To-Go.
security:
- BasicAuth: []
tags:
- Health
responses:
Expand All @@ -175,9 +198,14 @@ paths:
do not use the app. See the /__health endpoint for more detailed
information.
/__api:
servers:
- url: https://upp-prod-delivery-glb.upp.ft.com/__public-annotations-api/
- url: https://upp-staging-delivery-glb.upp.ft.com/__public-annotations-api/
get:
summary: API Documentation
description: Returns OpenAPI documentation for the application.
security:
- BasicAuth: []
tags:
- Info
responses:
Expand All @@ -187,5 +215,12 @@ paths:
text/plain;charset=utf-8:
schema:
type: string
servers:
- url: https://api.ft.com/
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
BasicAuth:
type: http
scheme: basic

0 comments on commit 1604435

Please sign in to comment.