Glossary #6
Glossary #6
Conversation
created new branches: quick-start-guide faqs glossary
deleted faqs.md from the glossary feature branch
deleted sandbox quick start guide from the glossary feature branch
Added terms and definitions to glossary
|
|
||
| ## 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. |
There was a problem hiding this comment.
"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. "
getting-started/glossary.md
Outdated
|
|
||
| ## 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 |
There was a problem hiding this comment.
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
getting-started/glossary.md
Outdated
|
|
||
| ## 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. |
There was a problem hiding this comment.
"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. |
There was a problem hiding this comment.
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
getting-started/glossary.md
Outdated
| 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). |
There was a problem hiding this comment.
"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).
getting-started/glossary.md
Outdated
|
|
||
| ## 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. |
There was a problem hiding this comment.
"The CFT sandbox is a secure test environment for you to try out CFT APIs for file transfers between systems in the internet zone."
getting-started/glossary.md
Outdated
|
|
||
| ## 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. | ||
|
|
||
| ## SG Tech Stack (SGTS) |
There was a problem hiding this comment.
Singapore Government Tech Stack (SGTS)
getting-started/glossary.md
Outdated
| 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. |
There was a problem hiding this comment.
"... to transit seamlessly between..."
"downstream services for a seamless ... "
Updated glossary with latest review comments.
Updated glossary. Pls review.