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

Reapply error corrections to api-security.md #76

Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 2 additions & 0 deletions sections/api-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ It is preferable to use the security policy features available in the WoG API Ga
| OAUTH | Filter -\> OAUTH | OAUTH can be used for authorizing the consumers | Optional as it depends on business requirements |
| CORS | Listeners-\>Path | CORS can be restricted at path level | Recommended |


## Protective Marking

Protective marking allows entities correctly assess the sensitivity or security classification of their information and adopt marking, handling, storage and disposal arrangements that guard against information compromise. Classification semantics may be unique to individual jurisdictions.
Expand Down Expand Up @@ -154,3 +155,4 @@ For Commonwealth data the Australian Government (gov.au) namespace should be use
State or territory governments may use the Australian Government (gov.au) namespace and semantics, or they may use a their own namespace value (different from the Australian Government) and apply rules specific to their jurisdiction.

Content (payload) classified as having a high business impact level or above MUST NOT be logged, unless over secure channels and to platforms approved for the retention of data to the appropriate classification.

12 changes: 6 additions & 6 deletions sections/api-versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ When new major versions are published the older version must be deprecated follo

## Minor Version

Minor version numbers are displayed on the API documentation page or part of a special management call to the API URI itself. To support this your API **MUST** implement a response to a GET request to the base URI of the API and return the following metadata in the response:
Minor version numbers are displayed on the API documentation page or part of a special management call to the API URI itself. To support this your API **SHOULD** implement a response to a GET request to the base URI of the API and return the following metadata in the response:

- **api_name:** The API Name
- **api_version:** The API Version with major and minor versions
- **api_released:** The date the API was released
- **api_documentation:** Links to the API Documentation
- **api_status:** To indicate whether an API is still active or has been deprecated.
- **api_name** or **apiName** : The API Name
- **api_version** or **apiVersion** : The API Version with major and minor versions
- **api_released** or **apiReleased** : The date the API was released
- **api_documentation:** or **apiDocumentation** : Links to the API Documentation
- **api_status** or **apiStatus** " To indicate whether an API is still active or has been deprecated.

Additional metadata can be added to the response if required.

Expand Down