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.

Sign up for GitHub

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

Create Camara-OAS-Sections-Guidelines.md #317

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
+108 −0
Draft

Create Camara-OAS-Sections-Guidelines.md #317

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a1af8e8
Create Camara-OAS-Sections-Guidelines.md
shilpa-padgaonkar Oct 15, 2024
5b341b4
Update Camara-OAS-Sections-Guidelines.md
shilpa-padgaonkar Oct 15, 2024
f2bb086
Update Camara-OAS-Sections-Guidelines.md
shilpa-padgaonkar Oct 15, 2024
707dcdc
Update Camara-OAS-Sections-Guidelines.md
shilpa-padgaonkar Oct 15, 2024
ae1cec9
Update Camara-OAS-Sections-Guidelines.md
shilpa-padgaonkar Oct 15, 2024
cfa4ba9
Update Camara-OAS-Sections-Guidelines.md
shilpa-padgaonkar Oct 15, 2024
ca98362
Update Camara-OAS-Sections-Guidelines.md
shilpa-padgaonkar Oct 15, 2024
7975033
Update Camara-OAS-Sections-Guidelines.md
shilpa-padgaonkar Oct 15, 2024
0d16b91
Update Camara-OAS-Sections-Guidelines.md
shilpa-padgaonkar Oct 15, 2024
191dfe1
Update Camara-OAS-Sections-Guidelines.md
shilpa-padgaonkar Oct 15, 2024
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
Prev Previous commit
Next Next commit
Loading
Loading status checks…
Update Camara-OAS-Sections-Guidelines.md
@shilpa-padgaonkar
shilpa-padgaonkar authored Oct 15, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode
commit 5b341b467de83596211ecac824b55c3b8b98010c
7 changes: 7 additions & 0 deletions documentation/Camara-OAS-Sections-Guidelines.md
View file
Original file line number Diff line number Diff line change
@@ -13,8 +13,15 @@
+ + [Terms of service](#tos)
+ + [Contact information](#contact)
+ + [License](#license)
+ [Servers](#servers)
+ [Paths](#paths)
+ [Components](#components)
+ [Security](#security)
+ [Tags](#tags)
+ [External Documentation](#ext-doc)

## Introduction
Camara uses OpenAPI Specification (OAS) to describe its APIs. The below guidelines specify the restrictions or conventions to be followed within the OAS yaml by all Camara APIs.

## Conventions
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.