openapi

OpenAPI Specification for ReportPortal API

This directory contains the OpenAPI specification. The specification includes:

• reportportal-api.yaml - is a autogenerated file that contains all apis.
• apis - the directory containing the OpenAPI specifications grouped by logical parts of the API.
• models - the directory containing the OpenAPI shared models.
• parameters - the directory containing the OpenAPI shared parameters.
• types - the directory contains adjusted base types like string, integer, etc.
• enums - the directory contains string types with enumerations.

All apis use shared models, security definitions and parameters. However, each api may have its own specific models, security definitions and parameters.

Lint, join and bundle

This project user Redocly CLI to lint, join and bundle the OpenAPI specification. You can use make commands to lint, join and bundle the OpenAPI specification.

Join all apis into one file api/openapi/reportportal-api.yaml.

make join

Lint specification file file.yaml. By default, the file is api/openapi/reportportal-api.yaml.

make lint file=file.yaml

Lint all apis.

make lint-all

Bundle specification file file.yaml into build/openapi/file.yaml. By default, the file is api/openapi/reportportal-api.yaml.

make bundle file=file.yaml

Bundle all apis into directory build/openapi/.

make bundle-all

Common tags for development status

There are common tags that are used in all endpoints for managing the status of the endpoint:

tags:
  - name: In progress
    description: Endpoints that are in designing
  - name: Ready for implementation
    description: Endpoints that are ready for development
  - name: Implemented
    description: Endpoints that are implemented

You mast use this tags as a secondary tag for each endpoint.