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.

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

Glossary #6

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
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
4 changes: 1 addition & 3 deletions _sidebar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
* [Overview](/)
* Getting Started
* [Try out CFT Sandbox](getting-started/try-out-sandbox)
* [Quick Start Guide](getting-started/sandbox-quick-start-guide)
* [Glossary](getting-started/glossary)
* [FAQs](getting-started/faqs)
* [Glossary](getting-started/glossary)
76 changes: 59 additions & 17 deletions getting-started/glossary.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,93 @@
# GLOSSARY
# GLOSSARY

## API
Application Programming Interface. A software intermediary that allows two applications to talk to each other.
This page provides a brief explanation of the key terms used in Cloud File Transfer
Copy link
Collaborator

@BrianLiuJS BrianLiuJS Sep 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

full stop pl

other thoughts looking through this is to help me determine who the intended readers are so that we can better adjust the writing and definitions to their needs


## API
Application Programming Interface. Refers to a set of functions and procedures that allows two applications to interact with each other programmatically in order to access the features or data of an operating system, application or other service.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Application Programming Interface (API) refers to a set of functions and procedures that allows two applications to interact with each other programmatically in order to access the features or data of an operating system, application or other service. "


## API Endpoint
The place that APIs send requests to and where the resource resides.
Refers to a URL of a server or service, that is, the location from which APIs can access the API resources that they need to carry out the function.

## API Gateway
An API management tool that sits between a client and a collection of backend services.

## API Gateway Id

An API management tool that sits between a client and a collection of backend services. It accepts all application programming interface (API) calls, aggregates the various services required to fulfill them, and returns the appropriate result.
Copy link
Collaborator

@BrianLiuJS BrianLiuJS Sep 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"It accepts all API calls, aggregates the various services required to fulfil them, and returns the appropriate result."

--- dont need to expand API and edited "fulfil"


## API Key
A unique identifier used by CFT to authenticate a calling program, this is used for rate limiting. It is assigned to an individual project.
A unique identifier used by CFT to authenticate a calling program. It is assigned to an individual project and used for rate limiting.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually, who is the glossary for? are we just defining tech terms, some of these are pretty generic.

I like the way that this particular response is trying to tie things back to CFT, so the reader can understand immediately how these 'terms' operate/supports CFT.

if it makes sense to to you too then we can consider rewritting in this format


## API Request
A call to a server using an API.
A call to a server using an API. It allows you to retrieve data from a data source, or to send data. APIs run on web servers, and expose endpoints to support the operations client applications use to provide their functionality. Each API request uses an HTTP method. The most common methods are GET , POST , PATCH , PUT , and DELETE.

- GET method retrieves data from an API
- POST method sends new data to an API
- PATCH and PUT methods update existing data
- DELETE removes existing data

## API Response
Response sent by the server according to the input header of the API request.
A response is defined by its HTTP status code and the data returned in the response body and/or headers.
For example:
200 OK - (When the request completes successfully and returns the response body.)

## AIAS
Application Infrastructure Architecture Standard.

## AWS
Amazon Web Services. It is the world’s most comprehensive and broadly adopted cloud platform, offering over 200 fully featured services from data centers globally.

## Client Id and Secret
Refers to the API credentials, required to generate an authorization token to make API calls.

## CFT
Cloud File Transfer. A centralized, fully managed file transfer service for the whole of government (WOG). CFT is a part of the SG Tech Stack (SGTS) and is hosted on the Government Commercial Cloud (GCC).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"A centralised, fully managed file transfer service for the whole-of-government (WOG). This service is part of the Singapore Tech Stack (SGTS) and is hosted on the Government Commercial Cloud (GCC).


A public identifier for applications. Required to generate an authorization token to make API calls.
## CDR
Content Disarm and Reconstruct also known as Threat Extraction, proactively protects against known and unknown threats contained in documents by removing executable content.

## Cloud File Transfer \(CFT\)
A lightweight, fully managed, API-driven service that allows agencies or businesses to transfer files easily, securely and efficiently at scale.
## GCC
The Government Commercial Cloud Service brings the modern innovations and capabilities of commercial cloud computing platforms to less sensitive Government systems. These leading ICT capabilities are augmented by robust cybersecurity measures and systems to protect the data that resides on commercial cloud platforms.

## Content Disarm and Reconstruct \(CDR\)

## HTTPS
Hypertext Transfer Protocol Secure is an extension of the Hypertext Transfer Protocol. It is used for secure communication over a computer network, and is widely used on the Internet.

## IM8
Instruction Manual 8. A management tool used in the Government to safeguard ICT & SS (Infocomm Technology and Smart Systems) assets and guides all Government agencies in adopting ICT & SS to enable their digital transformation.


## JWT
JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object.
JSON Web Token is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object.

## KMS
Key Management Service by AWS helps you create and manage cryptographic keys and control their use across a wide range of AWS services and in your applications.

## Malware Scanning
The process of detecting malware in a file.

## OpenAPI Specifications
The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.

## Payload
The body of an API request or response message.

## Project Id
## PGP
Pretty Good Privacy is an encryption program that provides cryptographic privacy and authentication for data communication.

## REST API
A REST API is an API that conforms to the design principles of the REST, or representational state transfer architectural style.

## Sandbox
CFT sandbox environment is a secure environment to try out CFT APIs. The sandbox supports file transfers in the internet zone between systems.
Copy link
Collaborator

@BrianLiuJS BrianLiuJS Sep 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"The CFT sandbox is a secure test environment for you to try out CFT APIs for file transfers between systems in the internet zone."


## SG Tech Stack (SGTS)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Singapore Government Tech Stack (SGTS)

SGTS consists of a series of common applications and platforms built by the Government that helps agencies build compliant applications easily.

## Amazon S3
Amazon Simple Storage Service is an object storage service that offers industry-leading scalability, data availability, security, and performance.

## SSE
Streaming SIMD Extensions is a processor technology that enables single instruction multiple data. It enables the instructions to handle multiple data elements.

## TechPass
A Single Sign-On, Identity & Access Management solution for developer services in SGTS, enabling users to transition seamlessly between services, while providing downstream services a seamless onboarding and consumption experience.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"... to transit seamlessly between..."

"downstream services for a seamless ... "


## Webhook
A way for an application to provide other applications with real-time information.