gvSIG projects pool

[Dolphin]

Timestamp=2020,9,1,10,21,14

Version=4

ViewMode=1

====

    gvSIG. Desktop Geographic Information System.

    Copyright (C) 2007-2012 gvSIG Association.

    This program is free software; you can redistribute it and/or

    modify it under the terms of the GNU General Public License

    as published by the Free Software Foundation; either version 2

    of the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License

    along with this program; if not, write to the Free Software

    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

    MA  02110-1301, USA.

    For any additional information, do not hesitate to contact us

    at info AT gvsig.com, or visit our website www.gvsig.com.

====

Put into this folder the resources needed by your classes.

This folder is added to the classpath, so you can load any resources 

through the ClassLoader.

By default, in this folder you can find an example of log4j configuration,

prepared to log messages through the console, so logging works when you

run your classes.

<?xml version="1.0" encoding="ISO-8859-1" ?>

<!--

    gvSIG. Desktop Geographic Information System.

    Copyright (C) 2007-2012 gvSIG Association.

    This program is free software; you can redistribute it and/or

    modify it under the terms of the GNU General Public License

    as published by the Free Software Foundation; either version 2

    of the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License

    along with this program; if not, write to the Free Software

    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

    MA  02110-1301, USA.

    For any additional information, do not hesitate to contact us

    at info AT gvsig.com, or visit our website www.gvsig.com.

-->

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<!-- 

Log4J configuration file for unit tests execution.

 -->

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

	<!-- Appender configuration to show logging messages through the console -->

	<appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">

		<layout class="org.apache.log4j.PatternLayout">

			<param name="ConversionPattern" value="%d{HH:mm:ss,SSS} %-5p [%c{2}.%M()]  %m%n" />

		</layout>

	</appender>

	<!-- 

	Activate logging messages of DEBUG level of higher only for the

	org.gvsig.tools packages.

	You can put full classes names or packages instead, to configure

	logging for all the classes and subpackages of the package.

	-->

	<category name="org.gvsig">

		<priority value="WARN" />

	</category>

	<category name="org.cresques">

		<priority value="WARN" />

	</category>

	<!-- 

	By default, show only logging messages of INFO level or higher, 

	through the previously configured CONSOLE appender. 

	-->

	<root>

		<priority value="INFO" />

		<appender-ref ref="CONSOLE" />

	</root>

</log4j:configuration>

<assembly>

    <id>package-main</id>

    <formats>

        <format>dir</format>

        <format>zip</format>

    </formats>

    <baseDirectory>${project.artifactId}</baseDirectory>

    <includeBaseDirectory>false</includeBaseDirectory>

    <files>

        <file>

            <source>target/${project.artifactId}-${project.version}.jar</source>

            <outputDirectory>.</outputDirectory>

        </file>

    </files>

    <fileSets>

        <fileSet>

            <directory>src/main/resources/data</directory>

            <outputDirectory>data</outputDirectory>

        </fileSet>

    </fileSets>

    <dependencySets>

        <dependencySet>

            <useProjectArtifact>false</useProjectArtifact>

            <useTransitiveDependencies>true</useTransitiveDependencies>

            <outputDirectory>lib</outputDirectory>

        </dependencySet>

    </dependencySets>

</assembly>

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2020 gvSIG Association

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.vcsgis.main;

import org.gvsig.tools.library.impl.DefaultLibrariesInitializer;

/**

 * Main executable class of vcsgis tool.

 *

 * @author gvSIG Team

 */

public class Main {

    public static void main(String args[]) {

        new DefaultLibrariesInitializer().fullInitialize();

    }

}

<?xml version="1.0" encoding="ISO-8859-1"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <artifactId>org.gvsig.vcsgis.main</artifactId>

    <packaging>jar</packaging>

    <name>${project.artifactId}</name>

    <parent>

        <groupId>org.gvsig</groupId>

        <artifactId>org.gvsig.vcsgis</artifactId>

        <version>1.0.0-SNAPSHOT</version>

    </parent>

    <build>

        <plugins>

            <plugin>

                <artifactId>maven-assembly-plugin</artifactId>

                <executions>

                    <execution>

                        <id>package-main</id>

                        <phase>package</phase>

                        <goals>

                            <goal>single</goal>

                        </goals>

                        <configuration>

                            <ignoreDirFormatExtensions>true</ignoreDirFormatExtensions>

                            <appendAssemblyId>false</appendAssemblyId>

                            <finalName>${project.artifactId}-${project.version}</finalName>

                            <descriptors>

                                <descriptor>src/main/assembly/package-main.xml</descriptor>

                            </descriptors>

                        </configuration>

                    </execution>

                </executions>

            </plugin>

            <plugin>

                <groupId>org.apache.maven.plugins</groupId>

                <artifactId>maven-jar-plugin</artifactId>

                <configuration>

                    <archive>

                        <manifest>

                            <addClasspath>true</addClasspath>

                            <mainClass>org.gvsig.vcsgis.main.Main</mainClass>

                            <classpathPrefix>lib</classpathPrefix>

                        </manifest>

                    </archive>

                </configuration>

            </plugin>

        </plugins>

    </build>

    <dependencies>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.vcsgis.lib.api</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.vcsgis.swing.api</artifactId>

            <scope>compile</scope>

        </dependency>

        <!-- runtime dependencies -->

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.vcsgis.lib.impl</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.vcsgis.swing.impl</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>${org.gvsig.metadata.lib.basic.impl}</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.fmap.dal.impl</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.fmap.dal.spi</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.fmap.dal.file.lib</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.fmap.dal.file.shp</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.fmap.dal.file.dbf</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.fmap.dal.db.lib</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.fmap.dal.db.h2</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.timesupport.lib.api</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>${org.gvsig.timesupport.lib.impl}</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>${org.gvsig.compat.impl}</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>${org.gvsig.fmap.geometry.impl}</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>            

            <artifactId>${org.gvsig.proj.lib.impl}</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.tools.swing.api</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.tools.swing.impl</artifactId>

            <scope>runtime</scope>

        </dependency>

    </dependencies>

</project>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

  <modelVersion>4.0.0</modelVersion>

  <parent>

    <groupId>org.gvsig</groupId>

    <artifactId>org.gvsig.vcsgis</artifactId>

    <version>1.0.39</version>

  </parent>

  <artifactId>org.gvsig.vcsgis.lib</artifactId>

  <packaging>pom</packaging>

  <modules>

    <module>org.gvsig.vcsgis.lib.api</module>

    <module>org.gvsig.vcsgis.lib.impl</module>

  </modules>

</project>

org.gvsig.vcsgis.lib.VCSGisLibrary

{

  "openapi": "3.0.1",

  "info": {

    "title": "VCSGis Simple API",

    "description": "Simple API to access VCSGis services",

    "version": "1.0.0"

  },

  "paths": {

    "/rowcreate": {

      "post": {

        "summary": "Create a new record in a table/entity",

        "operationId": "RowCreate",

        "requestBody": {

          "description": "Data for creating the new record",

          "content": {

            "application/json": {

              "schema": {

                "$ref": "#/components/schemas/RowCreateRequest"

              }

            }

          },

          "required": true

        },

        "responses": {

          "200": {

            "description": "successful operation",

            "content": {

              "application/json": {

                "schema": {

                  "$ref": "#/components/schemas/RowCreateResponse"

                }

              }

            }

          }

        }

      }

    },

    "/rowupdate": {

      "post": {

        "summary": "Update a record in a table/entity",

        "operationId": "RowUpdate",

        "requestBody": {

          "description": "Data for updating a record",

          "content": {

            "application/json": {

              "schema": {

                "$ref": "#/components/schemas/RowUpdateRequest"

              }

            }

          },

          "required": true

        },

        "responses": {

          "200": {

            "description": "successful operation",

            "content": {

              "application/json": {

                "schema": {

                  "$ref": "#/components/schemas/RowUpdateResponse"

                }

              }

            }

          }

        }

      }

    },

    "/rowdelete": {

      "post": {

        "summary": "Delete a record in a table/entity",

        "operationId": "RowDelete",

        "requestBody": {

          "description": "Data for deletion of a record",

          "content": {

            "application/json": {

              "schema": {

                "$ref": "#/components/schemas/RowDeleteRequest"

              }

            }

          },

          "required": true

        },

        "responses": {

          "200": {

            "description": "successful operation",

            "content": {

              "application/json": {

                "schema": {

                  "$ref": "#/components/schemas/RowDeleteResponse"

                }

              }

            }

          }

        }

      }

    },

    "/update": {

      "post": {

        "summary": "Brings changes from the repository to your working copy.",

        "operationId": "Update",

        "requestBody": {

          "description": "It contains the information to determine what data should be sent to the client.",

          "content": {

            "application/json": {

              "schema": {

                "$ref": "#/components/schemas/UpdateRequest"

              }

            }

          },

          "required": true

        },

        "responses": {

          "200": {

            "description": "successful operation",

            "content": {

              "application/json": {

                "schema": {

                  "$ref": "#/components/schemas/UpdateResponse"

                }

              }

            }

          }

        }

      }

    }

  },

  "components": {

    "examples": {

      "ObjectEntity": {

        "summary": "Entity example",

        "value": {

          "EntityCode": "00000000000002abcdef0123456789",

          "EntityName": "test",

          "DatatableName": "VCSGIS_DATA",

          "Description": "",

          "FeatureIdFieldName": "VCSGISCODE",

          "FeatureTypeAsJson": "...",

          "FieldForLabel": "text",

          "GeometryFieldName": "",

          "RevisionCode": "00000000000034abcdef0123456789",

          "TopologyPlanCode": "",

          "UserCode": "00000000000001abcdef0123456789"

        }

      },

      "ObjectUpdateEntry": {

        "summary": "UpdateEntry example",

        "value": {

          "DataCode": "00000000000100abcdef0123456789",

          "EntityCode": "00000000000002abcdef0123456789",

          "RevisionCode": "00000000000034abcdef0123456789",

          "Operation": 1,

          "RevisionNumber": 4,

          "EfectiveDate": "2020-02-19 10:11:12.123",

          "FeatureRelatedCode": "00000000000022abcdef0123456789",

          "Data": "{ \"id\": 4, \"text\": \"DD2\", \"VCSGISCODE\": \"00000000000022abcdef0123456789\"}"

        }

      }

    },

    "schemas": {

      "RowCreateRequest": {

        "required": [

          "EntityName",

          "LocalRevisionCode",

          "Data"

        ],

        "type": "object",

        "description": "This object represents a request to create a new record in a table.\n\nWhen the record is created, a unique code will be assigned with the VCS, overwriting the value of the VCSGISCODE attribute with the new value.",

        "example": {

          "EntityName": "test",

          "LocalRevisionCode": "00000000000014abcdef0123456789",

          "EfectiveDate": "2020-02-18 10:11:12.123",

          "Comment": "test row create (4, ddd)",

          "Data": "{ \"id\": 4, \"text\": \"DDD\", \"VCSGISCODE\": \"\"}"

        },

        "properties": {

          "EntityName": {

            "type": "string",

            "description": "Name of the table in which to create the new record"

          },

          "LocalRevisionCode": {

            "type": "string",

            "format": "string40",

            "description": "Code of the revision in which the client data is found"

          },

          "EfectiveDate": {

            "type": "string",

            "format": "timestamp",

            "description": "Efective date of the operation, in the format yyyy-mm-dd hh: MM: ss.LLL. In case of being null, the current date will be assigned."

          },

          "Comment": {

            "type": "string",

            "description": "Comment associated with the operation to be performed. It can be null."

          },

          "Data": {

            "type": "string",

            "description": "The feature data to create in the table coded as a string json. If the feature has the VCSGISCODE field it will be overwritten, assigning a new code to it."

          }

        }

      },

      "RowCreateResponse": {

        "type": "object",

        "description": "This object represents the response to a request to create a new record in a table.\n\nYou will inform us of the status of the request, as well as:\n  - The code of the new record created.\n  - The code of the revision in which the\n    table on the server.",

        "example": {

          "StatusCode": 0,

          "StatusMessage": "",

          "RelatedFeatureCode": "00000000000022abcdef0123456789",

          "EntityName": "test",

          "EntityCode": "00000000000002abcdef0123456789",

          "RevisionCode": "00000000000024abcdef0123456789"

        },

        "properties": {

          "StatusCode": {

            "type": "integer",

            "description": "Status code of the operation. Zero when the operation has been done correctly."

          },

          "StatusMessage": {

            "type": "string",

            "description": "In case the operation did not go well, a message describing the problem."

          },

          "RelatedFeatureCode": {

            "type": "string",

            "format": "string40",

            "description": "Code assigned to the VCSGISCODE field of the new record, which represents the identifier of this in the VCS."

          },

          "EntityName": {

            "type": "string",

            "description": "Name of the table in which the new one was requested to be created registry"

          },

          "EntityCode": {

            "type": "string",

            "format": "string40",

            "description": "Internal code associated with the table to identify it in a way Unique."

          },

          "RevisionCode": {

            "type": "string",

            "format": "string40",

            "description": "Code of the revision in which the data is found in the server after the operation is performed."

          }

        }

      },

      "RowUpdateRequest": {

        "required": [

          "EntityName",

          "LocalRevisionCode",

          "Data"

        ],

        "type": "object",

        "description": "This object represents a request to update a record in a table.\nIt is essential that the value of the VCSGISCODE attribute of the  data of the record that we want to update has the correct code,  since it is used to identify the record we want to update.",

        "example": {

          "EntityName": "test",

          "LocalRevisionCode": "00000000000024abcdef0123456789",

          "EfectiveDate": null,

          "Comment": "test row update (4, dd2)",

          "Data": "{ \"id\": 4, \"text\": \"DD2\", \"VCSGISCODE\": \"00000000000022abcdef0123456789\"}"

        },

        "properties": {

          "EntityName": {

            "type": "string",

            "description": "Name of the table in which the record is requested to be updated"

          },

          "LocalRevisionCode": {

            "type": "string",

            "format": "string40",

            "description": "Code of the revision in which the client data is located"

          },

          "EfectiveDate": {

            "type": "string",

            "format": "timestamp",

            "description": "Efective date of the operation, in the format yyyy-mm-dd hh: MM: ss.LLL. In case of being null, the current date will be assigned."

          },

          "Comment": {

            "type": "string",

            "description": "Comment associated with the operation to be performed. It can be null."

          },

          "Data": {

            "type": "string",

            "description": "The feature data to create in the table coded as a string json. The VCSGISCODE attribute must have a valid code and It will identify the record that is being updated."

          }

        }

      },

      "RowUpdateResponse": {

        "type": "object",

        "description": "This object represents the response to a request to update a record in a table.",

        "example": {

          "StatusCode": 0,

          "StatusMessage": "",

          "EntityName": "test",

          "EntityCode": "00000000000002abcdef0123456789",

          "RevisionCode": "00000000000029abcdef0123456789"

        },

        "properties": {

          "StatusCode": {

            "type": "integer",

            "description": "Operation status code. Zero when the operation has done correctly."

          },

          "StatusMessage": {

            "type": "string",

            "description": "In case the operation did not go well, a message describing the problem."

          },

          "EntityName": {

            "type": "string",

            "description": "Name of the table in which the requested was create the new record"

          },

          "EntityCode": {

            "type": "string",

            "format": "string40",

            "description": "Internal code associated with the table to identify."

          },

          "RevisionCode": {

            "type": "string",

            "format": "string40",

            "description": "Code of the revision in which the data is found in the server after the operation is performed."

          }

        }

      },

      "RowDeleteRequest": {

        "required": [

          "EntityName",

          "LocalRevisionCode",

          "RelatedFeatureCode"

        ],

        "type": "object",

        "description": "This object represents a request to delete a record in a table.\n\nThe record to be deleted will be identified by the value of the *RelatedFeatureCode* attribute.",

        "example": {

          "EntityName": "test",

          "LocalRevisionCode": "00000000000029abcdef0123456789",

          "RelatedFeatureCode": "00000000000022abcdef0123456789",

          "EfectiveDate": "2020-02-19 10:11:12.123",

          "Comment": "test row delete (4, dd2)"

        },

        "properties": {

          "EntityName": {

            "type": "string",

            "description": "Name of the table in which to delete the record"

          },

          "LocalRevisionCode": {

            "type": "string",

            "format": "string40",

            "description": "Code of the revision in which the client data is located"

          },

          "EfectiveDate": {

            "type": "string",

            "format": "timestamp",

            "description": "Efective date of the operation, in the format yyyy-mm-dd hh: MM: ss.LLL. In case of being null, the current date will be assigned."

          },

          "Comment": {

            "type": "string",

            "description": "Comment associated with the operation to be performed. It can be null."

          },

          "RelatedFeatureCode": {

            "type": "string",

            "format": "string40",

            "description": "Code of the record to be deleted. Delete the record that have the value of the VCSGISCODE attribute as the value of this field."

          }

        }

      },

      "RowDeleteResponse": {

        "type": "object",

        "description": "This object represents the response to a request to delete a record in a table.",

        "example": {

          "StatusCode": 0,

          "StatusMessage": "",

          "EntityName": "test",

          "EntityCode": "00000000000002abcdef0123456789",

          "RevisionCode": "00000000000034abcdef0123456789"

        },

        "properties": {

          "StatusCode": {

            "type": "integer",

            "description": "Operation status code. Zero when the operation has done correctly."

          },

          "StatusMessage": {

            "type": "string",

            "description": "In case the operation did not go well, a message describing the problem."

          },

          "EntityName": {

            "type": "string",

            "description": "Name of the table in which the new one was requested to be created registry"

          },

          "EntityCode": {

            "type": "string",

            "format": "string40",

            "description": "Internal code associated with the table to identify."

          },

          "RevisionCode": {

            "type": "string",

            "format": "string40",

            "description": "Code of the revision in which the data is found in the server after the operation is performed."

          }

        }

      },

      "Entity": {

        "type": "object",

        "description": "This object represents an entity or table on the server.  It contains the metadata of this, such as its name, code, code of  the last revision, user who created it ...",

        "properties": {

          "EntityCode": {

            "type": "string",

            "format": "string40",

            "description": "Code of this entity"

          },

          "EntityName": {

            "type": "string",

            "description": "Name of this entity"

          },

          "DatatableName": {

            "type": "string",

            "description": "Name of the table in which the entity's data is stored"

          },

          "Description": {

            "type": "string"

          },

          "FeatureIdFieldName": {

            "type": "string"

          },

          "FeatureTypeAsJson": {

            "type": "string"

          },

          "FieldForLabel": {

            "type": "string"

          },

          "GeometryFieldName": {

            "type": "string"

          },

          "RevisionCode": {

            "type": "string"

          },

          "TopologyPlanCode": {

            "type": "string"

          },

          "UserCode": {

            "type": "string"

          }

        }

      },

      "UpdateEntry": {

        "type": "object",

        "description": "This object defines the data associated with a record that has  changed in a table. It tells us if we should delete our record  from the working copy, update it or insert a new one, as well  as the data associated with the records.",

        "properties": {

          "DataCode": {

            "type": "string",

            "description": "Unique identifier asociated to this entry."

          },

          "EntityCode": {

            "type": "string",

            "description": "The entity code, table, asociated to this entry."

          },

          "RevisionCode": {

            "type": "string",

            "description": "The revision code asociated to this entry."

          },

          "Operation": {

            "type": "integer",

            "description": "The operation asociated to this entry:\n  - 0 for delete\n  - 1 for update\n  - 2 for insert",

            "enum": [

              0,

              1,

              2

            ]

          },

          "RevisionNumber": {

            "type": "string",

            "description": "The revision number asociated to this entry"

          },

          "EfectiveDate": {

            "type": "string",

            "format": "timestamp",

            "description": "The efective date asociated to this entry"

          },

          "FeatureRelatedCode": {

            "type": "string",

            "description": "The code that identify the feature in the VCS."

          },

          "Data": {

            "type": "string",

            "description": "The feature data coded as a json string."

          }

        }

      },

      "UpdateRequest": {

        "required": [

          "EntityName",

          "LocalRevisionCode"

        ],

        "type": "object",

        "description": "This object contains the information necessary to determine what  data should be sent to the client so that the data of a table is  updated with the last revision of this one.",

        "example": {

          "EntityName": "test",

          "LocalRevisionCode": "00000000000024abcdef0123456789"

        },

        "properties": {

          "EntityName": {

            "type": "string",

            "description": "Name of the table we want to update"

          },

          "LocalRevisionCode": {

            "type": "string",

            "format": "string40",

            "description": "Code of the revision in which the client data is located"

          }

        }

      },

      "UpdateResponse": {

        "type": "object",

        "description": "It contains the necessary data to update the local table and to go  from being in the revision in which it is to the last revision  that the server contains.",

        "example": {

          "StatusCode": 0,

          "StatusMessage": "",

          "Entity": {

            "$ref": "#/components/examples/ObjectEntity/value"

          },

          "Data": [

            {

              "$ref": "#/components/examples/ObjectUpdateEntry/value"

            }

          ]

        },

        "properties": {

          "StatusCode": {

            "type": "integer",

            "description": "Operation status code. Zero when the operation has done correctly."

          },

          "StatusMessage": {

            "type": "string",

            "description": "In case the operation did not go well, a message describing the problem."

          },

          "Entity": {

            "$ref": "#/components/schemas/Entity"

          },

          "Data": {

            "type": "array",

            "items": {

              "$ref": "#/components/schemas/UpdateEntry"

            }

          }

        }

      }

    }

  }

}

#

# https://editor.swagger.io/

#

openapi: 3.0.1

info:

  title: VCSGis Simple API

  description: >-

    Simple API to access VCSGis services

  version: 1.0.0

tags:

  - name: Application API

    description: >

      They provide the commands necessary to implement a 

      desktop client of a VCS.

  - name: Developers API

    description: >

      It exposes services to facilitate integration with 

      third-party applications.

paths:

  /rowcreate:

    post:

      tags:

        - Develeloppers API

      summary: >

          Create a new record in a table/entity

      operationId: RowCreate

      requestBody:

        description: >

          Data for creating the new record

        content:

          application/json:

            schema:

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

        required: true

      responses:

        '200':

          description: successful operation

          content:

            application/json:

              schema:

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

  /rowupdate:

    post:

      tags:

        - Develeloppers API

      summary: >

          Update a record in a table/entity

      operationId: RowUpdate

      requestBody:

        description: >

          Data for updating a record

        content:

          application/json:

            schema:

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

        required: true

      responses:

        '200':

          description: successful operation

          content:

            application/json:

              schema:

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

  /rowdelete:

    post:

      tags:

        - Develeloppers API

      summary: >

        Delete a record in a table/entity

      operationId: RowDelete

      requestBody:

        description: >

          Data for deletion of a record

        content:

          application/json:

            schema:

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

        required: true

      responses:

        '200':

          description: successful operation

          content:

            application/json:

              schema:

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

  /update:

    post:

      tags:

        - Application API

      summary: >

         Brings changes from the repository to your working copy.

      operationId: Update

      requestBody:

        description: >

          It contains the information to determine what data should be sent to the client.

        content:

          application/json:

            schema:

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

        required: true

      responses:

        '200':

          description: successful operation

          content:

            application/json:

              schema:

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

components:

  examples:

    ObjectEntity:

      summary: Entity example

      value:

        EntityCode: "00000000000002abcdef0123456789"

        EntityName: "test"

        DatatableName: "VCSGIS_DATA"

        Description: ""

        FeatureIdFieldName: "VCSGISCODE"

        FeatureTypeAsJson: "..."

        FieldForLabel: "text"

        GeometryFieldName: ""

        RevisionCode: "00000000000034abcdef0123456789"

        TopologyPlanCode: ""

        UserCode: "00000000000001abcdef0123456789"

    ObjectUpdateEntry: 

      summary: UpdateEntry example

      value:

        DataCode: "00000000000100abcdef0123456789"

        EntityCode: "00000000000002abcdef0123456789"

        RevisionCode: "00000000000034abcdef0123456789"

        Operation: 1

        RevisionNumber: 4

        EfectiveDate: "2020-02-19 10:11:12.123"

        FeatureRelatedCode: "00000000000022abcdef0123456789"

        Data: "{ \"id\": 4, \"text\": \"DD2\", \"VCSGISCODE\": \"00000000000022abcdef0123456789\"}"    

  schemas:

    RowCreateRequest:

      required:

      - EntityName

      - LocalRevisionCode

      - Data

      type: object

      description: >

        This object represents a request to create a new record in a

        table.

        When the record is created, a unique code will be assigned with

        the VCS, overwriting the value of the VCSGISCODE attribute with the new

        value.

      example:

        EntityName: "test"

        LocalRevisionCode: "00000000000014abcdef0123456789"

        EfectiveDate: "2020-02-18 10:11:12.123"

        Comment: "test row create (4, ddd)"

        Data: "{ \"id\": 4, \"text\": \"DDD\", \"VCSGISCODE\": \"\"}"

      properties:

        EntityName:

          type: string

          description: >

            Name of the table in which to create the new record

        LocalRevisionCode:

          type: string

          format: string40

          description: >

            Code of the revision in which the client data is found

        EfectiveDate:

          type: string

          format: timestamp

          description: >

            Efective date of the operation, in the format yyyy-mm-dd

            hh: MM: ss.LLL. In case of being null, the current date will be assigned.

        Comment:

          type: string

          description: >

            Comment associated with the operation to be performed. It can be null.

        Data:

          type: string

          description: >

            The feature data to create in the table coded as a

            string json. If the feature has the VCSGISCODE field it will be

            overwritten, assigning a new code to it.

    RowCreateResponse:

      type: object

      description: >

        This object represents the response to a request to create a new

        record in a table.

        You will inform us of the status of the request, as well as:

          - The code of the new record created.

          - The code of the revision in which the

            table on the server.

      example:

        StatusCode: 0

        StatusMessage: ""

        RelatedFeatureCode: "00000000000022abcdef0123456789"

        EntityName: "test"

        EntityCode: "00000000000002abcdef0123456789"

        RevisionCode: "00000000000024abcdef0123456789"

      properties:

        StatusCode:

          type: integer

          description: >

            Status code of the operation. Zero when the operation has been

            done correctly.

        StatusMessage:

          type: string

          description: >

            In case the operation did not go well, a message describing

            the problem.

        RelatedFeatureCode:

          type: string

          format: string40

          description: >

            Code assigned to the VCSGISCODE field of the new record, which

            represents the identifier of this in the VCS.

        EntityName:

          type: string

          description: >

            Name of the table in which the new one was requested to be created

            registry

        EntityCode:

          type: string

          format: string40

          description: >

            Internal code associated with the table to identify it in a way

            Unique.

        RevisionCode:

          type: string

          format: string40

          description: >

            Code of the revision in which the data is found in the

            server after the operation is performed.

    RowUpdateRequest:

      required:

      - EntityName

      - LocalRevisionCode

      - Data

      type: object

      description: >

        This object represents a request to update a record in a

        table.

        It is essential that the value of the VCSGISCODE attribute of the 

        data of the record that we want to update has the correct code, 

        since it is used to identify the record we want to update.

      example:

        EntityName: "test"

        LocalRevisionCode: "00000000000024abcdef0123456789"

        EfectiveDate: null

        Comment: "test row update (4, dd2)"

        Data: "{ \"id\": 4, \"text\": \"DD2\", \"VCSGISCODE\": \"00000000000022abcdef0123456789\"}"

      properties:

        EntityName:

          type: string

          description: >

            Name of the table in which the record is requested to be updated

        LocalRevisionCode:

          type: string

          format: string40

          description: >

            Code of the revision in which the client data is located

        EfectiveDate:

          type: string

          format: timestamp

          description: >

            Efective date of the operation, in the format yyyy-mm-dd

            hh:MM:ss.LLL. In case of being null, the current date will be assigned.

        Comment:

          type: string

          description: >

            Comment associated with the operation to be performed. It can be null.

        Data:

          type: string

          description: >

            The feature data to create in the table coded as a

            string json. The VCSGISCODE attribute must have a valid code and

            It will identify the record that is being updated.

    RowUpdateResponse:

      type: object

      description: >

        This object represents the response to a request to update a

        record in a table.

      example:

        StatusCode: 0

        StatusMessage: ""

        EntityName: "test"

        EntityCode: "00000000000002abcdef0123456789"

        RevisionCode: "00000000000029abcdef0123456789"

      properties:

        StatusCode:

          type: integer

          description: >

            Operation status code. Zero when the operation has

            done correctly.

        StatusMessage:

          type: string

          description: >

            In case the operation did not go well, a message describing

            the problem.

        EntityName:

          type: string

          description: >

            Name of the table in which the requested was create the new record

        EntityCode:

          type: string

          format: string40

          description: >

            Internal code associated with the table to identify.

        RevisionCode:

          type: string

          format: string40

          description: >

            Code of the revision in which the data is found in the

            server after the operation is performed.

    RowDeleteRequest:

      required:

      - EntityName

      - LocalRevisionCode

      - RelatedFeatureCode

      type: object

      description: >

        This object represents a request to delete a record in a

        table.

        The record to be deleted will be identified by the value of the

        *RelatedFeatureCode* attribute.

      example:

        EntityName: "test"

        LocalRevisionCode: "00000000000029abcdef0123456789"

        RelatedFeatureCode: "00000000000022abcdef0123456789"

        EfectiveDate: "2020-02-19 10:11:12.123"

        Comment: "test row delete (4, dd2)"

      properties:

        EntityName:

          type: string

          description: >

            Name of the table in which to delete the record

        LocalRevisionCode:

          type: string

          format: string40

          description: >

            Code of the revision in which the client data is located

        EfectiveDate:

          type: string

          format: timestamp

          description: >

            Efective date of the operation, in the format yyyy-mm-dd

            hh:MM:ss.LLL. In case of being null, the current date will be assigned.

        Comment:

          type: string

          description: >

            Comment associated with the operation to be performed. It can be null.

        RelatedFeatureCode:

          type: string

          format: string40

          description: >

            Code of the record to be deleted. Delete the record that

            have the value of the VCSGISCODE attribute as the value of this field.

    RowDeleteResponse:

      type: object

      description: >

        This object represents the response to a request to delete a

        record in a table.

      example:

        StatusCode: 0

        StatusMessage: ""

        EntityName: "test"

        EntityCode: "00000000000002abcdef0123456789"

        RevisionCode: "00000000000034abcdef0123456789"

      properties:

        StatusCode:

          type: integer

          description: >

            Operation status code. Zero when the operation has

            done correctly.

        StatusMessage:

          type: string

          description: >

            In case the operation did not go well, a message describing

            the problem.

        EntityName:

          type: string

          description: >

            Name of the table in which the new one was requested to be created

            registry

        EntityCode:

          type: string

          format: string40

          description: >

            Internal code associated with the table to identify.

        RevisionCode:

          type: string

          format: string40

          description: >

            Code of the revision in which the data is found in the

            server after the operation is performed.

    Entity:

      type: object

      description: >

        This object represents an entity or table on the server. 

        It contains the metadata of this, such as its name, code, code of 

        the last revision, user who created it ...

      properties:

        EntityCode:

          type: string

          format: string40

          description: >

            Code of this entity

        EntityName:

          type: string

          description: >

            Name of this entity

        DatatableName:

          type: string

          description: >

            Name of the table in which the entity's data is stored

        Description:

          type: string

        FeatureIdFieldName:

          type: string

        FeatureTypeAsJson:

          type: string

        FieldForLabel:

          type: string

        GeometryFieldName:

          type: string

        RevisionCode:

          type: string

        TopologyPlanCode:

          type: string

        UserCode:

          type: string

    UpdateEntry:

      type: object

      description: >

        This object defines the data associated with a record that has 

        changed in a table. It tells us if we should delete our record 

        from the working copy, update it or insert a new one, as well 

        as the data associated with the records.

      properties:

        DataCode:

          type: string

          description: >

            Unique identifier asociated to this entry.

        EntityCode:

          type: string

          description: >

            The entity code, table, asociated to this entry.

        RevisionCode:

          type: string

          description: >

            The revision code asociated to this entry.

        Operation:

          type: integer

          description: >

            The operation asociated to this entry:

              - 0 for delete

              - 1 for update

              - 2 for insert

          enum:

            - 0 # Delete

            - 1 # Update

            - 2 # Insert

        RevisionNumber:

          type: string

          description: >

            The revision number asociated to this entry

        EfectiveDate:

          type: string

          format: timestamp

          description: >

            The efective date asociated to this entry

        FeatureRelatedCode:

          type: string

          description: >

            The code that identify the feature in the VCS.

        Data:

          type: string

          description: >

            The feature data coded as a json string.

    UpdateRequest:

      required:

      - EntityName

      - LocalRevisionCode

      type: object

      description: >

        This object contains the information necessary to determine what 

        data should be sent to the client so that the data of a table is 

        updated with the last revision of this one.

      example:

        EntityName: "test"

        LocalRevisionCode: "00000000000024abcdef0123456789"

      properties:

        EntityName:

          type: string

          description: >

            Name of the table we want to update

        LocalRevisionCode:

          type: string

          format: string40

          description: >

            Code of the revision in which the client data is located

    UpdateResponse:

      type: object

      description: >

        It contains the necessary data to update the local table and to go 

        from being in the revision in which it is to the last revision 

        that the server contains.

      example:

        StatusCode: 0

        StatusMessage: ""

        Entity:

          $ref: '#/components/examples/ObjectEntity/value'

        Data: 

            - $ref: '#/components/examples/ObjectUpdateEntry/value'

      properties:

        StatusCode:

          type: integer

          description: >

            Operation status code. Zero when the operation has

            done correctly.

        StatusMessage:

          type: string

          description: >

            In case the operation did not go well, a message describing

            the problem.

        Entity:

          $ref: "#/components/schemas/Entity"

        Data:

          type: "array"

          items:

            $ref: "#/components/schemas/UpdateEntry"