Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added preferred usage of camelCase

...

In ONAP, the info.version field MUST be set to the fully-qualified version number of the Swagger file (ex: 1.4.18). Further information about versioning is ONAP may be found at: https://wikilf-onap.onapatlassian.orgnet/wiki/display/DW/ONAP+API+Common+Versioning+Strategy+%28CVS%29+Guidelines

Extension Fields

Within the info section, the following are extensions of the Swagger specification and SHALL be required for ONAP:

...

For ONAP, it is recommended that the operationId field within a path operation be formed as: <objectName>"_"<><operation>. (e.g., pets_get)petsGet) using camelCase for word separation.

Operation Summary

The summary field within a path operation MUST be present and non-empty.

...

Forward slash separator (/) must be used to indicate a hierarchical relationship

Use Prefer camelCase, but if necessary use Hyphens (-) instead of Underscores (_)  if separation of words is needed in the URI

...

Further Information may be found at: https://wikilf-onap.onapatlassian.orgnet/wiki/display/DW/RESTful+API+Design+Specification

Pluralization of Resource names

...

Property names should be simple, meaningful, and descriptive with defined semantics.

Property names MUST be camel-casedcamelCased, ascii strings.

The first character MUST be a letter.

...