README.md 3.89 KB
Newer Older
Silvia Almagia's avatar
Silvia Almagia committed

- [Objectives](#objectives)
- [Associated workspaces](#associated-workspaces)
  - [Overview and fast access](#overview-and-fast-access)
  - [ETSI Forge](#etsi-forge)
  - [ETSI Lab](#etsi-lab)
  - [ETSI ISG ARF Sharepoint](#etsi-isg-arf-sharepoint)
- [Selected Tools](#selected-tools)
  - [Editors](#editors)
  - [OpenAPI tools](#openapi-tools)
  - [Development tools](#development-tools)

# Objectives

Project dedicated to the development of an API standardizing the exchanges with a World Storage Representation service.

# Associated workspaces

## Overview and fast access

Goto | ARF|STF|Other|Description
----------|---------|--|--|--
 [ETSI Portal](https://portal.etsi.org/home.aspx ) | yes | yes |-|Portal
 [Sharepoint Auth.](https://etsihq.sharepoint.com/:f:/s/Whitepapers/EoitUA6NUWtCkUe69C5x7Y4B-ctyOMXB6SX-jrR0oElYkw ) | yes | yes |-|Whitepapers|
 [Sharepoint ~~Auth.~~](https://etsihq.sharepoint.com/:f:/s/Whitepapers/EoitUA6NUWtCkUe69C5x7Y4B15QjoFl-a_wpimo0hs-Jrw  ) | yes | yes |-|Whitepapers|
 [Teams](https://teams.microsoft.com/) |-|yes|-|STF620
 [ETSI Forge](https://forge.etsi.org/rep/arf) | yes | yes |-|Specification
 [ETSI Lab](https://labs.etsi.org/rep/arf) |-| yes |-|Development

Eric Villain's avatar
Eric Villain committed

Eric Villain's avatar
Eric Villain committed

## ETSI Forge
Eric Villain's avatar
Eric Villain committed
Contains the source code and specification related to the World Storage API.

- Type internal (The group and any internal projects can be viewed by any user logged in w. EOL) can be made public when needed

**Maintainer**: Eric Villain
Eric Villain's avatar
Eric Villain committed

- [Access to the Forge](https://forge.etsi.org/rep/arf)

- [Access to the project: ARF005 – World Storage API](https://forge.etsi.org/rep/arf/arf005)
Eric Villain's avatar
Eric Villain committed

## ETSI Lab
Eric Villain's avatar
Eric Villain committed
Contains the source code and documentation related to the wrappers, the Unity plugin and the validation application. We will create an independent project for each item. A project called Management has already been created for administrative purpose.

- Type: Internal (The group and any internal projects can be viewed by any user logged in w. EOL) can be made public when needed
Eric Villain's avatar
Eric Villain committed

**Maintainer**: Patrick Harms

- [Access to the Lab](https://labs.etsi.org/rep/arf)

- [Access to the subgroup World Storage API Helpers](https://labs.etsi.org/rep/arf/world-storage-api-helpers)
Eric Villain's avatar
Eric Villain committed

Eric Villain's avatar
Eric Villain committed
## ETSI ISG ARF Sharepoint
Eric Villain's avatar
Eric Villain committed
Contains temporary office documents that are edited collaboratively and all other stuff that don’t fit in the Forge or the Lab.

- [Access with authentication](https://etsihq.sharepoint.com/:f:/s/Whitepapers/EoitUA6NUWtCkUe69C5x7Y4B-ctyOMXB6SX-jrR0oElYkw)

- [Access without authentication](https://etsihq.sharepoint.com/:f:/s/Whitepapers/EoitUA6NUWtCkUe69C5x7Y4B15QjoFl-a_wpimo0hs-Jrw)

# Selected Tools

## Editors

- General purpose editor
  - [VSCode](doc/VSCode.md)

- Diagram editor (especially for use case diagrams)
  - [Diagrams.net](http://diagrams.net)
    - GUI based, easy to build diagrams, almost no learning curve, nice PNG export, easy to modify, easy to change objects positions, online and offline version, free of charge, open source. Good documentation. Used by the group in the architecture definition phase.
    - Available plugin for VSCode
    - [Ofline version](https://github.com/jgraph/drawio-desktop/releases/tag/v15.4.0)

- Diagram editor (for sequence diagrams)
  - [PlantUML](https://plantuml.com)
    - Seems powerful (didn’t miss anything until now), small learning curve, modify with copy paste. Nicely rendered. Sometimes “compilation fails” but errors messages are explicit.
    - Available plugin for VSCode
Eric Villain's avatar
Eric Villain committed

## OpenAPI tools
Eric Villain's avatar
Eric Villain committed

- Swaggereditor
  - [ETSI REST API tools](https://forge.etsi.org/index.php/tools/rest-apis)
  - [Swagger Editor](https://forge.etsi.org/swagger/editor/)  
Eric Villain's avatar
Eric Villain committed

- API generation
  - [OpenAPI generator](https://openapi-generator.tech/)
Eric Villain's avatar
Eric Villain committed

- Codegen
  - [Swagger Codegen](https://swagger.io/tools/swagger-codegen/)
  - [Swagger Codegen documentation](https://swagger.io/docs/open-source-tools/swagger-codegen/)
Eric Villain's avatar
Eric Villain committed

## Development tools
Eric Villain's avatar
Eric Villain committed

- Visual Studio
- Visual Studio Code
- Unity 3D