Commit 322e9997 authored by Sylvain Renault's avatar Sylvain Renault
Browse files

Referecing new components/responses params. 

Some corrections in the main MD file.
Commenting "application/xml" block while this create some warnings in the generator.
parent 6d3f113c

API/openapi.yaml

+12 −9
Original line number Diff line number Diff line
@@ -12,6 +12,8 @@ openapi: "3.0.0" 
# - Rules for RESTful error code RFC2616: https://datatracker.ietf.org/doc/html/rfc2616#section-10

# - Guide: https://restfulapi.net/http-status-codes/

#

# Last Version: 04.03.2022

#

info: 

  version: 0.0.4

  title: World Storage API
@@ -25,6 +27,7 @@ paths: 
  /ping:

    get:

      summary: Test the server availability

      operationId: getPing

      responses:

        '200':

          description: OK, world storage alive.
@@ -56,9 +59,9 @@ paths: 
            application/json:

              schema:

                $ref: '#/components/schemas/Trackable'

            application/xml:

              schema:

                $ref: '#/components/schemas/Trackable'

            #application/xml:

            #  schema:

            #    $ref: '#/components/schemas/Trackable'

      responses:

        '200':

          description: OK, returns the UUID of the Trackable defined by the world storage.
@@ -155,9 +158,9 @@ paths: 
            application/json:

              schema:

                $ref: '#/components/schemas/WorldAnchor'             

            application/xml:

              schema:

                $ref: '#/components/schemas/WorldAnchor'

            #application/xml:

            #  schema:

            #    $ref: '#/components/schemas/WorldAnchor'

      responses:

        '200':

          description: OK, returns the UUID of the World Anchor defined by the world storage.
@@ -254,9 +257,9 @@ paths: 
            application/json:

              schema:

                $ref: '#/components/schemas/WorldLink'

            application/xml:

              schema:

                $ref: '#/components/schemas/WorldLink'

            #application/xml:

            #  schema:

            #    $ref: '#/components/schemas/WorldLink'

      responses:

        '200':

          description: OK, returns the UUID of the link defined by the world storage.

README.md

+4 −4
Original line number Diff line number Diff line
@@ -115,19 +115,19 @@ Install the tool with "npm", see: https://openapi-generator.tech/docs/installati 


### Validating the api



> npx @openapitools/openapi-generator-cli validate -i .\openapi.yaml

> npx @openapitools/openapi-generator-cli validate -i API/openapi.yaml



### Example C++ Server (Pistache)



> npx @openapitools/openapi-generator-cli generate -i openapi.yaml  -g cpp-pistache-server -o ./codeGeneration/sever/cpp/pistache

> npx @openapitools/openapi-generator-cli generate -i API/openapi.yaml  -g cpp-pistache-server -o ./CodeGeneration/sever/cpp/pistache



### Example ASP.NET Server (C#)



> npx @openapi-generator-cli generate -i openapi.yaml -g aspnetcore -o ./codeGeneration/server/aspnetcore

> npx @openapitools/openapi-generator-cli generate -i API/openapi.yaml -g aspnetcore -o ./CodeGeneration/server/aspnetcore



### Example C# Client



> npx @openapitools/openapi-generator-cli generate -i openapi.yaml  -g csharp-netcore -o ./codeGeneration/client/c#/netcore

> npx @openapitools/openapi-generator-cli generate -i API/openapi.yaml  -g csharp -o ./CodeGeneration/client/csharp



# Branching Policy

Distributed version control systems like Git offers developers great flexibility to share and manage code. But a branching policy is crucial to collaborate more easily while keeping track of releases with bug fixes.