openrqm 1.0.4

openrqm #

This is the OpenRQM API specification. OpenRQM Docs - Github

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements #

Dart 2.0 or later

Installation & Usage

Github #

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  openrqm:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local #

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  openrqm:
    path: /path/to/openrqm

Tests #

TODO

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:openrqm/api.dart';


var api_instance = DocumentApi();

try {
    var result = api_instance.getDocument();
    print(result);
} catch (e) {
    print("Exception when calling DocumentApi->getDocument: $e\n");
}

Documentation for API Endpoints #

All URIs are relative to https://virtserver.swaggerhub.com/benjaminSchilling33/OpenRQM/1.0.0

ClassMethodHTTP requestDescription
DocumentApigetDocumentGET /documentGet a document
DocumentsApigetDocumentsGET /documentsGet all documents
ElementApipatchElementPATCH /elementUpdate an element
ElementApipostElementPOST /elementAdd an element
ElementApiputElementPUT /elementUpdate an element
ElementsApigetElementsGET /elementsGet all elements
WorkspaceApigetWorkspaceGET /workspaceGet a workspace
WorkspacesApigetWorkspacesGET /workspacesGet all workspaces

Documentation For Models #

Documentation For Authorization #

All endpoints do not require authorization.

Author #

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  openrqm: ^1.0.4

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:openrqm/api.dart';
import 'package:openrqm/api/documents_api.dart';
import 'package:openrqm/api/document_api.dart';
import 'package:openrqm/api/elements_api.dart';
import 'package:openrqm/api/element_api.dart';
import 'package:openrqm/api/workspaces_api.dart';
import 'package:openrqm/api/workspace_api.dart';
import 'package:openrqm/api_client.dart';
import 'package:openrqm/api_exception.dart';
import 'package:openrqm/api_helper.dart';
import 'package:openrqm/auth/api_key_auth.dart';
import 'package:openrqm/auth/authentication.dart';
import 'package:openrqm/auth/http_basic_auth.dart';
import 'package:openrqm/auth/oauth.dart';
import 'package:openrqm/model/rqm_document.dart';
import 'package:openrqm/model/rqm_element.dart';
import 'package:openrqm/model/rqm_workspace.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
26
Health:
Code health derived from static analysis. [more]
73
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
50
Overall:
Weighted score of the above. [more]
45
Learn more about scoring.

We analyzed this package on Oct 21, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.1
  • pana: 0.12.21

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in libraries.

Health suggestions

Fix lib/model/rqm_document.dart. (-16.51 points)

Analysis of lib/model/rqm_document.dart reported 36 hints, including:

line 5 col 7: Don't explicitly initialize variables to null.

line 7 col 7: Don't explicitly initialize variables to null.

line 9 col 7: Don't explicitly initialize variables to null.

line 11 col 7: Don't explicitly initialize variables to null.

line 13 col 10: Don't explicitly initialize variables to null.

Fix lib/model/rqm_element.dart. (-5.84 points)

Analysis of lib/model/rqm_element.dart reported 12 hints, including:

line 5 col 7: Don't explicitly initialize variables to null.

line 7 col 7: Don't explicitly initialize variables to null.

line 9 col 7: Don't explicitly initialize variables to null.

line 11 col 10: Don't explicitly initialize variables to null.

line 13 col 10: Don't explicitly initialize variables to null.

Fix lib/model/rqm_workspace.dart. (-3.93 points)

Analysis of lib/model/rqm_workspace.dart reported 8 hints, including:

line 5 col 7: Don't explicitly initialize variables to null.

line 7 col 10: Don't explicitly initialize variables to null.

line 9 col 7: Don't explicitly initialize variables to null.

line 37 col 7: DO use curly braces for all flow control structures.

line 39 col 7: DO use curly braces for all flow control structures.

Fix additional 14 files with analysis or formatting issues. (-3.99 points)

Additional issues in the following files:

  • lib/api/element_api.dart (3 hints)
  • lib/api/document_api.dart (1 hint)
  • lib/api/documents_api.dart (1 hint)
  • lib/api/elements_api.dart (1 hint)
  • lib/api/workspace_api.dart (1 hint)
  • lib/api/workspaces_api.dart (1 hint)
  • lib/api.dart (Run dartfmt to format lib/api.dart.)
  • lib/api_client.dart (Run dartfmt to format lib/api_client.dart.)
  • lib/api_exception.dart (Run dartfmt to format lib/api_exception.dart.)
  • lib/api_helper.dart (Run dartfmt to format lib/api_helper.dart.)
  • lib/auth/api_key_auth.dart (Run dartfmt to format lib/auth/api_key_auth.dart.)
  • lib/auth/authentication.dart (Run dartfmt to format lib/auth/authentication.dart.)
  • lib/auth/http_basic_auth.dart (Run dartfmt to format lib/auth/http_basic_auth.dart.)
  • lib/auth/oauth.dart (Run dartfmt to format lib/auth/oauth.dart.)

Maintenance issues and suggestions

Provide a file named CHANGELOG.md. (-20 points)

Changelog entries help developers follow the progress of your package. See the example generated by stagehand.

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and openrqm.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
http >=0.12.0 <0.13.0 0.12.0+2
Transitive dependencies
async 2.4.0
charcode 1.1.2
collection 1.14.12
http_parser 3.1.3
meta 1.1.7
path 1.6.4
pedantic 1.8.0+1
source_span 1.5.5
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
Dev dependencies
test ^1.3.0