Attention A T users. To access the menus on this page please perform the following steps. 1. Please switch auto forms mode to off. 2. Hit enter to expand a main menu option (Health, Benefits, etc). 3. To enter and activate the submenu links, hit the down arrow. You will now be able to tab or arrow up or down through the submenu options to access/activate the submenu links.

VA Technical Reference Model v 24.7

Open Application Programming Interface (API) Specification (OAS)
Open Application Programming Interface (API) Specification (OAS) Standard or Specification

General InformationGeneral Information help

Technologies must be operated and maintained in accordance with Federal and Department security and privacy policies and guidelines. More information on the proper use of the TRM can be found on the TRM Proper Use Tab/Section.

Website: Go to site
Description: Open Application Programming Interface (API) Specification (OAS) defines a standard and programming language-agnostic interface description for Representational State Transfer (REST) Application Programming Interfaces (APIs). It allows users to discover and understand the capabilities of service without requiring access to source code, documentation, or inspection of network traffic. When defined via OpenAPI, users can follow and interact with the remote service with a minimal amount of implementation logic. Additionally, OpenAPI documents can be represented in either Yet Another Markup Language (YAML) or JavaScript Object Notation (JSON) formats.
Technology/Standard Usage Requirements: Users must ensure their use of this technology/standard is consistent with VA policies and standards, including, but not limited to, VA Handbooks 6102 and 6500; VA Directives 6004, 6513, and 6517; and National Institute of Standards and Technology (NIST) standards, including Federal Information Processing Standards (FIPS). Users must ensure sensitive data is properly protected in compliance with all VA regulations. Prior to use of this technology, users should check with their supervisor, Information Security Officer (ISO), Facility Chief Information Officer (CIO), or local Office of Information and Technology (OI&T) representative to ensure that all actions are consistent with current VA policies and procedures prior to implementation.
Section 508 Information:
Decision: View Decisions

Decision Source: TRM Mgmt Group
Decision Process: One-VA TRM v23.2
Decision Date: 02/09/2023 at 03:34:24 UTC
Aliases: Swagger; Swagger Specification, OpenAPI
Introduced By: TRM Request
Standards Body: Open API Initiative
- The information contained on this page is accurate as of the Decision Date (02/09/2023 at 03:34:24 UTC).